YaST Modules


Table of Contents

1. ALog
1.1. Authors
1.2. Summary of Module Globals
1.2.1.
1.2.2.
1.3. Global Functions
1.3.1. CommitPopup
1.3.2. Item
1.3.3. Note
1.4. Global Variables
1.5. Module Requirements
1.5.1. Module Imports
1.5.2. Module Includes
2. AddOnCreator
2.1. Authors
2.2. Summary of Module Globals
2.2.1.
2.2.2.
2.3. Global Functions
2.3.1. BuildAddOn
2.3.2. CommitCurrentProduct
2.3.3. CopyRPMs
2.3.4. CreateAddOnStructure
2.3.5. CreateDirectoryYaSTFiles
2.3.6. CreateISOImage
2.3.7. CreateMD5SUMS
2.3.8. Export
2.3.9. GenerateArchiveFiles
2.3.10. GenerateDirectories
2.3.11. GenerateGPGKey
2.3.12. GeneratePackageDescriptions
2.3.13. GenerateReleasePackage
2.3.14. GetKeyUID
2.3.15. GetProductInfo
2.3.16. ImportExistingProduct
2.3.17. Modified
2.3.18. PrepareBuild
2.3.19. Read
2.3.20. ReadPatternsFile
2.3.21. ReadProductXML
2.3.22. ResetCurrentProduct
2.3.23. SignAddOn
2.3.24. UpdateContentMap
2.3.25. Write
2.3.26. WriteContentFile
2.3.27. WriteLicensesFiles
2.3.28. WriteMediaFiles
2.3.29. WritePackageDescriptions
2.3.30. WritePatchesFiles
2.3.31. WritePatterns
2.3.32. WriteProductsFiles
2.3.33. WriteStringFiles
2.4. Global Variables
2.4.1. add_on_products
2.4.2. bootable
2.4.3. clone
2.4.4. content
2.4.5. content_key
2.4.6. current_product
2.4.7. generate_descriptions
2.4.8. import_path
2.4.9. modified
2.5. Module Requirements
2.5.1. Module Imports
2.5.2. Module Includes
3. AddOnProduct
3.1. Authors
3.2. Summary of Module Globals
3.2.1.
3.2.2.
3.3. Global Functions
3.3.1. AcceptedLicenseAndInfoFile
3.3.2. AddOnMode
3.3.3. AddPreselectedAddOnProducts
3.3.4. Disintegrate
3.3.5. DoInstall
3.3.6. Export
3.3.7. GetAbsoluteURL
3.3.8. Integrate
3.3.9. PrepareForRegistration
3.3.10. ProcessRegistration
3.3.11. ReIntegrateFromScratch
3.3.12. ReadTmpExportFilename
3.3.13. RegisterAddOnProduct
3.3.14. RemoveRegistrationFlag
3.3.15. RereadAllSCRAgents
3.3.16. SetPreselectedAddOnProductsType
3.3.17. TmpExportFilename
3.3.18. UpdateInstSys
3.4. Global Variables
3.4.1. add_on_products
3.4.2. last_ret
3.4.3. src_id
3.5. Module Requirements
3.5.1. Module Imports
3.5.2. Module Includes
4. Address
4.1. Authors
4.2. Summary of Module Globals
4.2.1.
4.2.2.
4.3. Global Functions
4.3.1. Check
4.3.2. Check4
4.3.3. Check6
4.3.4. CheckMAC
4.3.5. Valid4
4.3.6. ValidMAC
4.4. Global Variables
4.5. Module Requirements
4.5.1. Module Imports
4.5.2. Module Includes
5. Answering_machine
5.1. Authors
5.2. Summary of Module Globals
5.2.1.
5.2.2.
5.3. Global Functions
5.3.1. Read
5.3.2. Write
5.4. Global Variables
5.4.1. aconfig
5.4.2. gconfig
5.4.3. modified
5.4.4. users
5.5. Module Requirements
5.5.1. Module Imports
5.5.2. Module Includes
6. AppArmorDialogs
6.1. Authors
6.2. Summary of Module Globals
6.2.1.
6.2.2.
6.3. Global Functions
6.4. Global Variables
6.5. Module Requirements
7. Arch
7.1. Authors
7.2. Summary of Module Globals
7.2.1.
7.2.2.
7.3. Global Functions
7.3.1. alpha
7.3.2. arch_short
7.3.3. architecture
7.3.4. board_chrp
7.3.5. board_iseries
7.3.6. board_mac
7.3.7. board_mac_new
7.3.8. board_mac_old
7.3.9. board_pegasos
7.3.10. board_prep
7.3.11. board_wintel
7.3.12. has_pcmcia
7.3.13. has_smp
7.3.14. i386
7.3.15. ia64
7.3.16. is_laptop
7.3.17. is_uml
7.3.18. is_xen
7.3.19. is_xen0
7.3.20. is_xenU
7.3.21. mips
7.3.22. mips32
7.3.23. mips64
7.3.24. ppc
7.3.25. ppc32
7.3.26. ppc64
7.3.27. s390
7.3.28. s390_32
7.3.29. s390_64
7.3.30. setSMP
7.3.31. sparc
7.3.32. sparc32
7.3.33. sparc64
7.3.34. x11_setup_needed
7.3.35. x86_64
7.4. Global Variables
7.5. Module Requirements
8. AsciiFile
8.1. Authors
8.2. Summary of Module Globals
8.2.1.
8.2.2.
8.3. Global Functions
8.3.1. AppendLine
8.3.2. ChangeLineField
8.3.3. FindLineField
8.3.4. GetLine
8.3.5. GetLines
8.3.6. NumLines
8.3.7. ReadFile
8.3.8. RemoveLines
8.3.9. ReplaceLine
8.3.10. RewriteFile
8.3.11. SetComment
8.3.12. SetDelimiter
8.3.13. SetListWidth
8.4. Global Variables
8.5. Module Requirements
9. AuditLaf
9.1. Authors
9.2. Summary of Module Globals
9.2.1.
9.2.2.
9.3. Global Functions
9.3.1. Abort
9.3.2. AutoPackages
9.3.3. Export
9.3.4. GetAuditdOption
9.3.5. GetRules
9.3.6. GetRulesFile
9.3.7. Import
9.3.8. Modified
9.3.9. Modified
9.3.10. Overview
9.3.11. PollAbort
9.3.12. Read
9.3.13. SetAuditdOption
9.3.14. SetModified
9.3.15. SetWriteOnly
9.3.16. Summary
9.3.17. Write
9.3.18. WriteOnly
9.4. Global Variables
9.5. Module Requirements
9.5.1. Module Imports
9.5.2. Module Includes
10. AutoInstall
10.1. Authors
10.2. Summary of Module Globals
10.2.1.
10.2.2.
10.3. Global Functions
10.3.1. AutoInstall
10.3.2. Continue
10.3.3. Finish
10.3.4. PXELocalBoot
10.3.5. Save
10.3.6. TurnOff
10.4. Global Variables
10.5. Module Requirements
10.5.1. Module Imports
10.5.2. Module Includes
11. AutoInstallRules
11.1. Authors
11.2. Summary of Module Globals
11.2.1.
11.2.2.
11.3. Global Functions
11.3.1. AutoInstallRules
11.3.2. CreateDefault
11.3.3. CreateFile
11.3.4. Files
11.3.5. GetRules
11.3.6. Init
11.3.7. Merge
11.3.8. ProbeRules
11.3.9. Process
11.3.10. Read
11.3.11. StdErrLog
11.3.12. XML_cleanup
11.3.13. getHostid
11.3.14. getMAC
11.4. Global Variables
11.5. Module Requirements
11.5.1. Module Imports
11.5.2. Module Includes
12. AutofsUI
12.1. Authors
12.2. Summary of Module Globals
12.2.1.
12.2.2.
12.3. Global Functions
12.4. Global Variables
12.5. Module Requirements
12.5.1. Module Imports
12.5.2. Module Includes
13. AutoinstClass
13.1. Authors
13.2. Summary of Module Globals
13.2.1.
13.2.2.
13.3. Global Functions
13.3.1. Export
13.3.2. Files
13.3.3. Import
13.3.4. MergeClasses
13.3.5. Read
13.3.6. Save
13.3.7. Summary
13.3.8. findPath
13.4. Global Variables
13.5. Module Requirements
13.5.1. Module Imports
13.5.2. Module Includes
14. AutoinstClone
14.1. Authors
14.2. Summary of Module Globals
14.2.1.
14.2.2.
14.3. Global Functions
14.3.1. AutoinstClone
14.3.2. Export
14.3.3. General
14.3.4. Process
14.3.5. Write
14.3.6. createClonableList
14.4. Global Variables
14.5. Module Requirements
14.5.1. Module Imports
14.5.2. Module Includes
15. AutoinstCommon.ycp
15.1. Authors
15.2. Summary of Module Globals
15.2.1.
15.2.2.
15.3. Global Functions
15.3.1. isValidField
15.4. Global Variables
15.5. Module Requirements
16. AutoinstConfig
16.1. Authors
16.2. Summary of Module Globals
16.2.1.
16.2.2.
16.3. Global Functions
16.3.1. AutoinstConfig
16.3.2. ParseCmdLine
16.3.3. Save
16.3.4. SetProtocolMessage
16.3.5. ShellEscape
16.4. Global Variables
16.5. Module Requirements
16.5.1. Module Imports
16.5.2. Module Includes
17. AutoinstData
17.1. Authors
17.2. Summary of Module Globals
17.2.1.
17.2.2.
17.3. Global Functions
17.4. Global Variables
17.5. Module Requirements
18. AutoinstDrive
18.1. Authors
18.2. Summary of Module Globals
18.2.1.
18.2.2.
18.3. Global Functions
18.3.1. getNodeName
18.3.2. getNodeReference
18.3.3. isDrive
18.4. Global Variables
18.5. Module Requirements
18.5.1. Module Imports
18.5.2. Module Includes
19. AutoinstFile
19.1. Authors
19.2. Summary of Module Globals
19.2.1.
19.2.2.
19.3. Global Functions
19.3.1. Export
19.3.2. GetModified
19.3.3. Import
19.3.4. SetModified
19.3.5. Summary
19.3.6. Write
19.4. Global Variables
19.5. Module Requirements
19.5.1. Module Imports
19.5.2. Module Includes
20. AutoinstGeneral
20.1. Authors
20.2. Summary of Module Globals
20.2.1.
20.2.2.
20.3. Global Functions
20.3.1. AutoinstGeneral
20.3.2. Export
20.3.3. GetModified
20.3.4. Import
20.3.5. SetModified
20.3.6. SetSignatureHandling
20.3.7. Summary
20.3.8. Write
20.4. Global Variables
20.5. Module Requirements
20.5.1. Module Imports
20.5.2. Module Includes
21. AutoinstImage
21.1. Authors
21.2. Summary of Module Globals
21.2.1.
21.2.2.
21.3. Global Functions
21.4. Global Variables
21.5. Module Requirements
21.5.1. Module Imports
21.5.2. Module Includes
22. AutoinstLVM
22.1. Authors
22.2. Summary of Module Globals
22.2.1.
22.2.2.
22.3. Global Functions
22.3.1. AutoinstLVM
22.3.2. Init
22.3.3. Write
22.3.4. get_existing_pvs
22.4. Global Variables
22.5. Module Requirements
22.5.1. Module Imports
22.5.2. Module Includes
23. AutoinstPartPlan
23.1. Authors
23.2. Summary of Module Globals
23.2.1.
23.2.2.
23.3. Global Functions
23.3.1. Export
23.3.2. GetModified
23.3.3. Import
23.3.4. SetModified
23.3.5. Summary
23.3.6. updateTree
23.4. Global Variables
23.5. Module Requirements
23.5.1. Module Imports
23.5.2. Module Includes
24. AutoinstPartition
24.1. Authors
24.2. Summary of Module Globals
24.2.1.
24.2.2.
24.3. Global Functions
24.3.1. isPartition
24.4. Global Variables
24.5. Module Requirements
24.5.1. Module Imports
24.5.2. Module Includes
25. AutoinstRAID
25.1. Authors
25.2. Summary of Module Globals
25.2.1.
25.2.2.
25.3. Global Functions
25.3.1. AutoinstRAID
25.3.2. ExistingMDs
25.3.3. Init
25.3.4. Write
25.4. Global Variables
25.5. Module Requirements
25.5.1. Module Imports
25.5.2. Module Includes
26. AutoinstScripts
26.1. Authors
26.2. Summary of Module Globals
26.2.1.
26.2.2.
26.3. Global Functions
26.3.1. AddEditScript
26.3.2. Export
26.3.3. GetModified
26.3.4. Import
26.3.5. SetModified
26.3.6. Summary
26.3.7. Write
26.3.8. deleteScript
26.3.9. typeString
26.4. Global Variables
26.5. Module Requirements
26.5.1. Module Imports
26.5.2. Module Includes
27. AutoinstSoftware
27.1. Authors
27.2. Summary of Module Globals
27.2.1.
27.2.2.
27.3. Global Functions
27.3.1. AddModulePackages
27.3.2. AutoinstSoftware
27.3.3. Export
27.3.4. GetModified
27.3.5. Import
27.3.6. ReadHelper
27.3.7. RemoveModulePackages
27.3.8. SetModified
27.3.9. Summary
27.3.10. Write
27.3.11. addPostPackages
27.3.12. autoinstPackages
27.3.13. pmInit
27.4. Global Variables
27.5. Module Requirements
27.5.1. Module Imports
27.5.2. Module Includes
28. AutoinstStorage
28.1. Authors
28.2. Summary of Module Globals
28.2.1.
28.2.2.
28.3. Global Functions
28.3.1. GetModified
28.3.2. Import
28.3.3. ImportAdvanced
28.3.4. Overview
28.3.5. SetModified
28.3.6. Summary
28.3.7. Write
28.3.8. mountBy
28.4. Global Variables
28.5. Module Requirements
28.5.1. Module Imports
28.5.2. Module Includes
29. AutoinstX11
29.1. Authors
29.2. Summary of Module Globals
29.2.1.
29.2.2.
29.3. Global Functions
29.4. Global Variables
29.5. Module Requirements
29.5.1. Module Imports
29.5.2. Module Includes
30. Autologin
30.1. Authors
30.2. Summary of Module Globals
30.2.1.
30.2.2.
30.3. Global Functions
30.3.1. AskForDisabling
30.3.2. Disable
30.3.3. DisableAndWrite
30.3.4. Read
30.3.5. Use
30.3.6. Write
30.4. Global Variables
30.4.1. available
30.4.2. modified
30.4.3. pw_less
30.4.4. used
30.4.5. user
30.5. Module Requirements
30.5.1. Module Imports
30.5.2. Module Includes
31. BootArch
31.1. Authors
31.2. Summary of Module Globals
31.2.1.
31.2.2.
31.3. Global Functions
31.3.1. DefaultKernelParams
31.3.2. FailsafeKernelParams
31.3.3. InitrdImage
31.3.4. ResumeAvailable
31.3.5. VgaAvailable
31.4. Global Variables
31.5. Module Requirements
31.5.1. Module Imports
31.5.2. Module Includes
32. BootCommon
32.1. Authors
32.2. Summary of Module Globals
32.2.1.
32.2.2.
32.3. Global Functions
32.3.1. CreateLinuxSection
32.3.2. Dom0MemorySize
32.3.3. Export
32.3.4. Import
32.3.5. Propose
32.3.6. Read
32.3.7. Reset
32.3.8. Save
32.3.9. Section2Index
32.3.10. Summary
32.3.11. Update
32.3.12. Write
32.3.13. XenPresent
32.3.14. getBootloaders
32.3.15. getLoaderType
32.3.16. isTrustedGrub
32.3.17. setCurrentLoaderAttribs
32.3.18. setLoaderType
32.4. Global Variables
32.4.1. BootPartitionDevice
32.4.2. ExtendedPartitionDevice
32.4.3. RootPartitionDevice
32.4.4. activate
32.4.5. activate_changed
32.4.6. backup_mbr
32.4.7. bois_id_missing
32.4.8. bootloader_attribs
32.4.9. bootloaders
32.4.10. cached_settings_base_data_change_time
32.4.11. changed
32.4.12. current_bootloader_attribs
32.4.13. current_section
32.4.14. current_section_index
32.4.15. current_section_name
32.4.16. default_changed
32.4.17. del_parts
32.4.18. device_mapping
32.4.19. exports
32.4.20. files_edited
32.4.21. files_edited_warned
32.4.22. floppy_devices
32.4.23. global_options
32.4.24. globals
32.4.25. kernelCmdLine
32.4.26. loader_device
32.4.27. location_changed
32.4.28. mbrDisk
32.4.29. multipath_mapping
32.4.30. one_section_changed
32.4.31. opt_types
32.4.32. other_bl
32.4.33. partitioning_last_change
32.4.34. prefer_lilo
32.4.35. read_default_section_name
32.4.36. removed_sections
32.4.37. repl_mbr
32.4.38. save_all
32.4.39. save_on_finish
32.4.40. section_options
32.4.41. sections
32.4.42. sections_changed
32.4.43. selected_location
32.4.44. verbose
32.4.45. was_proposed
32.4.46. was_read
32.4.47. write_settings
32.5. Module Requirements
32.5.1. Module Imports
32.5.2. Module Includes
33. BootELILO
33.1. Authors
33.2. Summary of Module Globals
33.2.1.
33.2.2.
33.3. Global Functions
33.3.1. BootELILO
33.3.2. CreateGlobals
33.3.3. CreateSections
33.3.4. Export
33.3.5. FlagBootDefaultOnce
33.3.6. GetFunctions
33.3.7. Import
33.3.8. Initializer
33.3.9. Propose
33.3.10. Read
33.3.11. Reset
33.3.12. Save
33.3.13. Summary
33.3.14. Update
33.3.15. Write
33.3.16. getEfiMountPoint
33.3.17. getEliloConfFilename
33.3.18. getEliloConfSubdir
33.3.19. getEliloConfSubpath
33.4. Global Variables
33.4.1. create_efi_entry
33.4.2. elilo_conf_filename
33.4.3. old_efi_entry
33.5. Module Requirements
33.5.1. Module Imports
33.5.2. Module Includes
34. BootGRUB
34.1. Authors
34.2. Summary of Module Globals
34.2.1.
34.2.2.
34.3. Global Functions
34.3.1. BootGRUB
34.3.2. CheckAdditionalKernels
34.3.3. CreateSections
34.3.4. FlagOnetimeBoot
34.3.5. GetFunctions
34.3.6. Initializer
34.3.7. Propose
34.3.8. Read
34.3.9. Reset
34.3.10. Save
34.3.11. StandardGlobals
34.3.12. Summary
34.3.13. Update
34.3.14. Write
34.4. Global Variables
34.4.1. disks_order
34.4.2. insert_saved_mbr
34.4.3. merge_level
34.5. Module Requirements
34.5.1. Module Imports
34.5.2. Module Includes
35. BootLILO
35.1. Authors
35.2. Summary of Module Globals
35.2.1.
35.2.2.
35.3. Global Functions
35.3.1. BootLILO
35.3.2. CreateGlobals
35.3.3. CreateSections
35.3.4. FlagOnetimeBoot
35.3.5. GetFunctions
35.3.6. Initializer
35.3.7. Propose
35.3.8. Read
35.3.9. Save
35.3.10. Update
35.3.11. Write
35.4. Global Variables
35.5. Module Requirements
35.5.1. Module Imports
35.5.2. Module Includes
36. BootPOWERLILO
36.1. Authors
36.2. Summary of Module Globals
36.2.1.
36.2.2.
36.3. Global Functions
36.3.1. BootPOWERLILO
36.3.2. CreateGlobals
36.3.3. CreateSections
36.3.4. Export
36.3.5. FlagOnetimeBoot
36.3.6. GetFunctions
36.3.7. Import
36.3.8. Initializer
36.3.9. LocationProposal
36.3.10. Propose
36.3.11. Read
36.3.12. Reset
36.3.13. Save
36.3.14. SaveInstSourceId
36.3.15. Summary
36.3.16. Update
36.3.17. Write
36.3.18. currentBoardInit
36.3.19. iSeriesInit
36.3.20. iSeriesWrite
36.4. Global Variables
36.5. Module Requirements
36.5.1. Module Imports
36.5.2. Module Includes
37. BootSupportCheck
37.1. Authors
37.2. Summary of Module Globals
37.2.1.
37.2.2.
37.3. Global Functions
37.3.1. DetectedProblems
37.3.2. GRUB
37.3.3. StringProblems
37.3.4. SystemSupported
37.3.5. check_BootDevice
37.4. Global Variables
37.5. Module Requirements
37.5.1. Module Imports
37.5.2. Module Includes
38. BootZIPL
38.1. Authors
38.2. Summary of Module Globals
38.2.1.
38.2.2.
38.3. Global Functions
38.3.1. BootZIPL
38.3.2. FlagOnetimeBoot
38.3.3. GetFunctions
38.3.4. Initializer
38.3.5. Propose
38.3.6. Read
38.3.7. Save
38.3.8. Summary
38.3.9. Update
38.3.10. Write
38.3.11. updateHardwareConfig
38.4. Global Variables
38.5. Module Requirements
38.5.1. Module Imports
38.5.2. Module Includes
39. Bootloader
39.1. Authors
39.2. Summary of Module Globals
39.2.1.
39.2.2.
39.3. Global Functions
39.3.1. Bootloader
39.3.2. DelDuplicatedSections
39.3.3. Export
39.3.4. FlagOnetimeBoot
39.3.5. Import
39.3.6. PreUpdate
39.3.7. Propose
39.3.8. Read
39.3.9. ReadOrProposeIfNeeded
39.3.10. Reset
39.3.11. ResetEx
39.3.12. ResolveSymlink
39.3.13. RunDelayedUpdates
39.3.14. SetWriteMode
39.3.15. Summary
39.3.16. Update
39.3.17. UpdateConfiguration
39.3.18. UpdateGfxMenu
39.3.19. Write
39.3.20. WriteInstallation
39.3.21. getBootDevice
39.3.22. getDefaultSection
39.3.23. getKernelParam
39.3.24. getLoaderType
39.3.25. getProposedDefaultSection
39.3.26. getRootDevice
39.3.27. getSectionsList
39.3.28. listKernelParams
39.3.29. setBootDevice
39.3.30. setLoaderType
39.3.31. setRootDevice
39.4. Global Variables
39.4.1. cached_proposal
39.4.2. proposed_cfg_changed
39.4.3. repeating_write
39.5. Module Requirements
39.5.1. Module Imports
39.5.2. Module Includes
40. CWM
40.1. Authors
40.2. Summary of Module Globals
40.2.1.
40.2.2.
40.3. Global Functions
40.3.1. AdjustButtons
40.3.2. CreateWidgets
40.3.3. DisableButtons
40.3.4. GetProcessedWidget
40.3.5. InitNull
40.3.6. MergeHelps
40.3.7. OkCancelBox
40.3.8. PrepareDialog
40.3.9. ReplaceWidgetHelp
40.3.10. Run
40.3.11. SetValidationFailedHandler
40.3.12. ShowAndRun
40.3.13. ShowAndRunOrig
40.3.14. StoreNull
40.3.15. StringsOfTerm
40.3.16. ValidateBasicType
40.3.17. ValidateMaps
40.3.18. ValidateValueType
40.3.19. cleanupWidgets
40.3.20. handleWidgets
40.3.21. initWidgets
40.3.22. mergeFunctions
40.3.23. prepareWidget
40.3.24. saveWidgets
40.3.25. validateWidget
40.3.26. validateWidgets
40.4. Global Variables
40.5. Module Requirements
40.5.1. Module Imports
40.5.2. Module Includes
41. CWMFirewallInterfaces
41.1. Authors
41.2. Summary of Module Globals
41.2.1.
41.2.2.
41.3. Global Functions
41.3.1. CreateInterfacesWidget
41.3.2. CreateOpenFirewallWidget
41.3.3. DisableOpenFirewallWidget
41.3.4. DisplayDetailsPopup
41.3.5. EnableOpenFirewallWidget
41.3.6. InitAllowedInterfaces
41.3.7. InterfacesHandle
41.3.8. InterfacesHandleWrapper
41.3.9. InterfacesInit
41.3.10. InterfacesInitWrapper
41.3.11. InterfacesStore
41.3.12. InterfacesStoreWrapper
41.3.13. InterfacesValidate
41.3.14. InterfacesValidateWrapper
41.3.15. Modified
41.3.16. OpenFirewallHandle
41.3.17. OpenFirewallHandleWrapper
41.3.18. OpenFirewallHelp
41.3.19. OpenFirewallHelpTemplate
41.3.20. OpenFirewallInit
41.3.21. OpenFirewallInitWrapper
41.3.22. OpenFirewallModified
41.3.23. OpenFirewallStore
41.3.24. OpenFirewallStoreWrapper
41.3.25. OpenFirewallWidgetExists
41.3.26. StoreAllowedInterfaces
41.4. Global Variables
41.5. Module Requirements
41.5.1. Module Imports
41.5.2. Module Includes
42. CWMServiceStart
42.1. Authors
42.2. Summary of Module Globals
42.2.1.
42.2.2.
42.3. Global Functions
42.3.1. AutoStartHelp
42.3.2. AutoStartHelpTemplate
42.3.3. AutoStartHelpXinetdTemplate
42.3.4. AutoStartInit
42.3.5. AutoStartInitWrapper
42.3.6. AutoStartStore
42.3.7. AutoStartStoreWrapper
42.3.8. AutoStartXinetdHelp
42.3.9. CreateAutoStartWidget
42.3.10. CreateLdapWidget
42.3.11. CreateStartStopWidget
42.3.12. EnableLdapHelp
42.3.13. EnableLdapHelpTemplate
42.3.14. LdapHandle
42.3.15. LdapHandleWrapper
42.3.16. LdapInit
42.3.17. LdapInitWrapper
42.3.18. StartStopHandle
42.3.19. StartStopHandleWrapper
42.3.20. StartStopHelp
42.3.21. StartStopHelpTemplate
42.3.22. StartStopInit
42.3.23. StartStopInitWrapper
42.4. Global Variables
42.5. Module Requirements
42.5.1. Module Imports
42.5.2. Module Includes
43. CWMTab
43.1. Authors
43.2. Summary of Module Globals
43.2.1.
43.2.2.
43.3. Global Functions
43.3.1. CleanUp
43.3.2. CreateWidget
43.3.3. CurrentTab
43.3.4. Handle
43.3.5. HandleWrapper
43.3.6. Init
43.3.7. InitWrapper
43.3.8. LastTab
43.3.9. Store
43.3.10. Validate
43.4. Global Variables
43.5. Module Requirements
43.5.1. Module Imports
43.5.2. Module Includes
44. CWMTsigKeys
44.1. Authors
44.2. Summary of Module Globals
44.2.1.
44.2.2.
44.3. Global Functions
44.3.1. AnalyzeTSIGKeyFile
44.3.2. CreateWidget
44.3.3. DeleteTSIGKeyFromDisk
44.3.4. Files2KeyMaps
44.3.5. Files2Keys
44.3.6. Handle
44.3.7. HandleWrapper
44.3.8. Init
44.3.9. InitWrapper
44.3.10. NormalizeFilename
44.3.11. Store
44.3.12. StoreWrapper
44.4. Global Variables
44.5. Module Requirements
44.5.1. Module Imports
44.5.2. Module Includes
45. CaMgm
45.1. Authors
45.2. Summary of Module Globals
45.2.1.
45.2.2.
45.3. Global Functions
45.4. Global Variables
45.4.1. autoYaSTSettings
45.4.2. certificateSequence
45.4.3. currentCA
45.4.4. currentCertificate
45.4.5. currentDefault
45.4.6. currentRequest
45.4.7. emailList
45.4.8. passwdMap
45.4.9. prop_settingsWritten
45.5. Module Requirements
45.5.1. Module Imports
45.5.2. Module Includes
46. Call
46.1. Authors
46.2. Summary of Module Globals
46.2.1.
46.2.2.
46.3. Global Functions
46.3.1. Function
46.4. Global Variables
46.5. Module Requirements
47. CasaAts
47.1. Authors
47.2. Summary of Module Globals
47.2.1.
47.2.2.
47.3. Global Functions
47.3.1. Abort
47.3.2. AutoPackages
47.3.3. Export
47.3.4. Import
47.3.5. Modified
47.3.6. Modified
47.3.7. Overview
47.3.8. Read
47.3.9. Summary
47.3.10. Write
47.4. Global Variables
47.4.1. Settings
47.4.2. modified
47.4.3. proposal_valid
47.4.4. write_only
47.5. Module Requirements
47.5.1. Module Imports
47.5.2. Module Includes
48. CheckMedia
48.1. Authors
48.2. Summary of Module Globals
48.2.1.
48.2.2.
48.3. Global Functions
48.3.1. Info
48.3.2. Release
48.4. Global Variables
48.5. Module Requirements
48.5.1. Module Imports
48.5.2. Module Includes
49. Cluster
49.1. Authors
49.2. Summary of Module Globals
49.2.1.
49.2.2.
49.3. Global Functions
49.3.1. Abort
49.3.2. AutoPackages
49.3.3. Export
49.3.4. Import
49.3.5. Modified
49.3.6. Modified
49.3.7. Overview
49.3.8. Read
49.3.9. SetModified
49.3.10. SetWriteOnly
49.3.11. Summary
49.3.12. Write
49.3.13. WriteOnly
49.4. Global Variables
49.5. Module Requirements
49.5.1. Module Imports
49.5.2. Module Includes
50. CommandLine
50.1. Authors
50.2. Summary of Module Globals
50.2.1.
50.2.2.
50.3. Global Functions
50.3.1. Abort
50.3.2. Aborted
50.3.3. Command
50.3.4. Done
50.3.5. Error
50.3.6. Init
50.3.7. Interactive
50.3.8. Parse
50.3.9. PasswordInput
50.3.10. Print
50.3.11. PrintNoCR
50.3.12. PrintVerbose
50.3.13. PrintVerboseNoCR
50.3.14. Run
50.3.15. Scan
50.3.16. StartGUI
50.3.17. UniqueOption
50.3.18. UserInput
50.3.19. Verbose
50.3.20. YesNo
50.4. Global Variables
50.5. Module Requirements
50.5.1. Module Imports
50.5.2. Module Includes
51. ConfigHistory
51.1. Authors
51.2. Summary of Module Globals
51.2.1.
51.2.2.
51.3. Global Functions
51.3.1. CommitChanges
51.3.2. Init
51.3.3. InitFiles
51.4. Global Variables
51.5. Module Requirements
52. Confirm
52.1. Authors
52.2. Summary of Module Globals
52.2.1.
52.2.2.
52.3. Global Functions
52.3.1. Delete
52.3.2. DeleteSelected
52.3.3. Detection
52.3.4. MustBeRoot
52.4. Global Variables
52.5. Module Requirements
52.5.1. Module Imports
52.5.2. Module Includes
53. Console
53.1. Authors
53.2. Summary of Module Globals
53.2.1.
53.2.2.
53.3. Global Functions
53.3.1. Check
53.3.2. Console
53.3.3. Init
53.3.4. Restore
53.3.5. Save
53.3.6. SelectFont
53.4. Global Variables
53.5. Module Requirements
53.5.1. Module Imports
53.5.2. Module Includes
54. Crash
54.1. Authors
54.2. Summary of Module Globals
54.2.1.
54.2.2.
54.3. Global Functions
54.3.1. AskRun
54.3.2. Failed
54.3.3. FailedLast
54.3.4. Finish
54.3.5. LastFinished
54.3.6. Read
54.3.7. Run
54.3.8. Write
54.4. Global Variables
54.4.1. filename
54.5. Module Requirements
54.5.1. Module Imports
54.5.2. Module Includes
55. Cron
55.1. Authors
55.2. Summary of Module Globals
55.2.1.
55.2.2.
55.3. Global Functions
55.3.1. AddSimple
55.3.2. Read
55.3.3. Write
55.4. Global Variables
55.5. Module Requirements
56. CustomDialogs
56.1. Authors
56.2. Summary of Module Globals
56.2.1.
56.2.2.
56.3. Global Functions
56.4. Global Variables
56.5. Module Requirements
57. DASDController
57.1. Authors
57.2. Summary of Module Globals
57.2.1.
57.2.2.
57.3. Global Functions
57.3.1. Abort
57.3.2. ActivateDisk
57.3.3. AutoPackages
57.3.4. Available
57.3.5. DeactivateDisk
57.3.6. Export
57.3.7. FormatDisks
57.3.8. FourDigitHex
57.3.9. GetPartitionInfo
57.3.10. Import
57.3.11. IsAvailable
57.3.12. Modified
57.3.13. Modified
57.3.14. ProbeDisks
57.3.15. Read
57.3.16. Summary
57.3.17. Write
57.4. Global Variables
57.4.1. modified
57.4.2. proposal_valid
57.4.3. write_only
57.5. Module Requirements
57.5.1. Module Imports
57.5.2. Module Includes
58. DNS
58.1. Authors
58.2. Summary of Module Globals
58.2.1.
58.2.2.
58.3. Global Functions
58.3.1. Export
58.3.2. Import
58.3.3. IsHostLocal
58.3.4. Read
58.3.5. ReadHostDomain
58.3.6. ReadNameserver
58.3.7. Summary
58.3.8. Write
58.4. Global Variables
58.4.1. domain
58.4.2. hostname
58.4.3. modified
58.4.4. proposal_valid
58.5. Module Requirements
58.5.1. Module Imports
58.5.2. Module Includes
59. DSL
59.1. Authors
59.2. Summary of Module Globals
59.2.1.
59.2.2.
59.3. Global Functions
59.3.1. Add
59.3.2. Adding
59.3.3. Commit
59.3.4. Delete
59.3.5. Edit
59.3.6. Export
59.3.7. Import
59.3.8. Modified
59.3.9. Overview
59.3.10. Propose
59.3.11. Read
59.3.12. Select
59.3.13. SelectHW
59.3.14. Summary
59.3.15. UsesDevice
59.3.16. Write
59.4. Global Variables
59.4.1. AbortFunction
59.4.2. capiadsl
59.4.3. interface
59.4.4. modemip
59.4.5. pppmode
59.4.6. vpivci
59.5. Module Requirements
59.5.1. Module Imports
59.5.2. Module Includes
60. DefaultDesktop
60.1. Authors
60.2. Summary of Module Globals
60.2.1.
60.2.2.
60.3. Global Functions
60.3.1. Description
60.3.2. Desktop
60.3.3. ForceReinit
60.3.4. GetAllDesktopsMap
60.3.5. Init
60.3.6. PatternsToDeselect
60.3.7. PatternsToSelect
60.3.8. PrefferedWindowManager
60.3.9. SelectedDesktops
60.3.10. SetDesktop
60.4. Global Variables
60.5. Module Requirements
60.5.1. Module Imports
60.5.2. Module Includes
61. Desktop
61.1. Authors
61.2. Summary of Module Globals
61.2.1.
61.2.2.
61.3. Global Functions
61.3.1. GroupList
61.3.2. ModuleList
61.3.3. Read
61.3.4. RunViaDesktop
61.3.5. Translate
61.4. Global Variables
61.4.1. AgentPath
61.4.2. Groups
61.4.3. Modules
61.5. Module Requirements
61.5.1. Module Imports
61.5.2. Module Includes
62. DevicesSelectionBox
62.1. Authors
62.2. Summary of Module Globals
62.2.1.
62.2.2.
62.3. Global Functions
62.3.1. Create
62.3.2. GetSelectedDevices
62.3.3. GetUnselectedDevices
62.4. Global Variables
62.5. Module Requirements
62.5.1. Module Imports
62.5.2. Module Includes
63. DhcpServerUI
63.1. Authors
63.2. Summary of Module Globals
63.2.1.
63.2.2.
63.3. Global Functions
63.3.1. DhcpServerUI
63.4. Global Variables
63.5. Module Requirements
63.5.1. Module Imports
63.5.2. Module Includes
64. DialogTree
64.1. Authors
64.2. Summary of Module Globals
64.2.1.
64.2.2.
64.3. Global Functions
64.3.1. AdjustButtons
64.3.2. AdjustButtonsAny
64.3.3. Run
64.3.4. RunAndHide
64.3.5. ShowAndRun
64.3.6. ShowFlat
64.3.7. ShowTree
64.4. Global Variables
64.5. Module Requirements
64.5.1. Module Imports
64.5.2. Module Includes
65. DirInstall
65.1. Authors
65.2. Summary of Module Globals
65.2.1.
65.2.2.
65.3. Global Functions
65.4. Global Variables
65.5. Module Requirements
65.5.1. Module Imports
65.5.2. Module Includes
66. Directory
66.1. Authors
66.2. Summary of Module Globals
66.2.1.
66.2.2.
66.3. Global Functions
66.3.1. Directory
66.3.2. ResetTmpDir
66.4. Global Variables
66.4.1. agentdir
66.4.2. bindir
66.4.3. clientdir
66.4.4. custom_workflow_dir
66.4.5. datadir
66.4.6. desktopdir
66.4.7. etcdir
66.4.8. icondir
66.4.9. imagedir
66.4.10. includedir
66.4.11. localedir
66.4.12. logdir
66.4.13. moduledir
66.4.14. schemadir
66.4.15. scrconfdir
66.4.16. themedir
66.4.17. tmpdir
66.4.18. vardir
66.5. Module Requirements
67. Distro
67.1. Authors
67.2. Summary of Module Globals
67.2.1.
67.2.2.
67.3. Global Functions
67.3.1. debian
67.3.2. fedora
67.3.3. suse
67.4. Global Variables
67.5. Module Requirements
68. DnsFakeTabs
68.1. Authors
68.2. Summary of Module Globals
68.2.1.
68.2.2.
68.3. Global Functions
68.4. Global Variables
68.5. Module Requirements
69. DnsServerHelperFunctions
69.1. Authors
69.2. Summary of Module Globals
69.2.1.
69.2.2.
69.3. Global Functions
69.3.1. IsReverseZone
69.4. Global Variables
69.5. Module Requirements
69.5.1. Module Imports
69.5.2. Module Includes
70. DnsServerUI
70.1. Authors
70.2. Summary of Module Globals
70.2.1.
70.2.2.
70.3. Global Functions
70.4. Global Variables
70.4.1. popups
70.5. Module Requirements
70.5.1. Module Imports
70.5.2. Module Includes
71. DontShowAgain
71.1. Authors
71.2. Summary of Module Globals
71.2.1.
71.2.2.
71.3. Global Functions
71.3.1. GetCurrentConfigurationMap
71.3.2. GetDefaultReturn
71.3.3. GetShowQuestionAgain
71.3.4. RemoveShowQuestionAgain
71.3.5. SetDefaultReturn
71.3.6. SetShowQuestionAgain
71.4. Global Variables
71.5. Module Requirements
71.5.1. Module Imports
71.5.2. Module Includes
72. Drbd
72.1. Authors
72.2. Summary of Module Globals
72.2.1.
72.2.2.
72.3. Global Functions
72.4. Global Variables
72.5. Module Requirements
72.5.1. Module Imports
72.5.2. Module Includes
73. DualMultiSelectionBox
73.1. Authors
73.2. Summary of Module Globals
73.2.1.
73.2.2.
73.3. Global Functions
73.4. Global Variables
73.5. Module Requirements
74. Dump
74.1. Authors
74.2. Summary of Module Globals
74.2.1.
74.2.2.
74.3. Global Functions
74.3.1. Abort
74.3.2. AutoPackages
74.3.3. Available
74.3.4. AvailableDisks
74.3.5. Export
74.3.6. FormatDisk
74.3.7. Import
74.3.8. Modified
74.3.9. Modified
74.3.10. Read
74.3.11. Summary
74.3.12. Write
74.4. Global Variables
74.4.1. modified
74.4.2. proposal_valid
74.4.3. write_only
74.5. Module Requirements
74.5.1. Module Imports
74.5.2. Module Includes
75. EdirUtilsLUM
75.1. Authors
75.2. Summary of Module Globals
75.2.1.
75.2.2.
75.3. Global Functions
75.3.1. DoesEdirectoryTreeExist
75.3.2. GetLeafNameLDAP
75.3.3. GetLeafNameNDS
75.3.4. GetTreeName
75.4. Global Variables
75.5. Module Requirements
75.5.1. Module Imports
75.5.2. Module Includes
76. Encoding
76.1. Authors
76.2. Summary of Module Globals
76.2.1.
76.2.2.
76.3. Global Functions
76.3.1. Encoding
76.3.2. GetCodePage
76.3.3. GetEncLang
76.3.4. GetUtf8Lang
76.3.5. Restore
76.3.6. SetEncLang
76.3.7. SetUtf8Lang
76.4. Global Variables
76.4.1. console
76.5. Module Requirements
76.5.1. Module Imports
76.5.2. Module Includes
77. FTP
77.1. Authors
77.2. Summary of Module Globals
77.2.1.
77.2.2.
77.3. Global Functions
77.3.1. Dir
77.3.2. Get
77.4. Global Variables
77.5. Module Requirements
78. Fax
78.1. Authors
78.2. Summary of Module Globals
78.2.1.
78.2.2.
78.3. Global Functions
78.3.1. Read
78.3.2. Write
78.4. Global Variables
78.4.1. aconfig
78.4.2. gconfig
78.4.3. modified
78.4.4. users
78.5. Module Requirements
78.5.1. Module Imports
78.5.2. Module Includes
79. FileChanges
79.1. Authors
79.2. Summary of Module Globals
79.2.1.
79.2.2.
79.3. Global Functions
79.3.1. CheckFiles
79.3.2. FileChanged
79.3.3. StoreFileCheckSum
79.4. Global Variables
79.5. Module Requirements
79.5.1. Module Imports
79.5.2. Module Includes
80. FileSystems
80.1. Authors
80.2. Summary of Module Globals
80.2.1.
80.2.2.
80.3. Global Functions
80.3.1. GetAllFileSystems
80.3.2. GetMountString
80.4. Global Variables
80.5. Module Requirements
80.5.1. Module Imports
80.5.2. Module Includes
81. FileUtils
81.1. Authors
81.2. Summary of Module Globals
81.2.1.
81.2.2.
81.3. Global Functions
81.3.1. CheckAndCreatePath
81.3.2. Exists
81.3.3. GetFileRealType
81.3.4. GetFileType
81.3.5. GetOwnerGroupID
81.3.6. GetOwnerUserID
81.3.7. GetSize
81.3.8. IsBlock
81.3.9. IsCharacterDevice
81.3.10. IsDirectory
81.3.11. IsFifo
81.3.12. IsFile
81.3.13. IsLink
81.3.14. IsSocket
81.3.15. MD5sum
81.4. Global Variables
81.5. Module Requirements
81.5.1. Module Imports
81.5.2. Module Includes
82. FingerprintReader
82.1. Authors
82.2. Summary of Module Globals
82.2.1.
82.2.2.
82.3. Global Functions
82.3.1. AutoPackages
82.3.2. CryptedHomesEnabled
82.3.3. Export
82.3.4. Import
82.3.5. Read
82.3.6. ReadFingerprintReaderDevices
82.3.7. ShortSummary
82.3.8. Summary
82.3.9. UpdatedArchPackages
82.3.10. Write
82.4. Global Variables
82.4.1. import_dir
82.4.2. modified
82.4.3. required_packages
82.4.4. use_pam
82.4.5. write_only
82.5. Module Requirements
82.5.1. Module Imports
82.5.2. Module Includes
83. Firstboot
83.1. Authors
83.2. Summary of Module Globals
83.2.1.
83.2.2.
83.3. Global Functions
83.3.1. Export
83.3.2. Import
83.3.3. Summary
83.3.4. Write
83.4. Global Variables
83.5. Module Requirements
83.5.1. Module Imports
83.5.2. Module Includes
84. FtpServer
84.1. Authors
84.2. Summary of Module Globals
84.2.1.
84.2.2.
84.3. Global Functions
84.3.1. Abort
84.3.2. Export
84.3.3. GetModified
84.3.4. Import
84.3.5. InitDaemon
84.3.6. Modified
84.3.7. Modified
84.3.8. OptionsSummary
84.3.9. Overview
84.3.10. PollAbort
84.3.11. Read
84.3.12. Summary
84.3.13. ValueUIEdit
84.3.14. Write
84.3.15. WriteSettings
84.3.16. WriteToEditMap
84.3.17. WriteUpload
84.3.18. WriteXinetd
84.4. Global Variables
84.4.1. DEFAULT_CONFIG
84.4.2. EDIT_SETTINGS
84.4.3. PURE_SETTINGS
84.4.4. UI_keys
84.4.5. VS_SETTINGS
84.4.6. anon_homedir
84.4.7. anon_uid
84.4.8. change_permissions
84.4.9. create_upload_dir
84.4.10. ftps
84.4.11. modified
84.4.12. proposal_valid
84.4.13. pure_ftp_allowed_permissios_upload
84.4.14. pure_ftp_xinetd_running
84.4.15. pure_ftpd_xinet_conf
84.4.16. pureftpd_installed
84.4.17. pureftpd_xined_id
84.4.18. start_xinetd
84.4.19. stop_daemon_xinetd
84.4.20. upload_good_permission
84.4.21. vsftp_xinetd_running
84.4.22. vsftpd_edit
84.4.23. vsftpd_installed
84.4.24. vsftpd_xined_id
84.4.25. write_only
84.5. Module Requirements
84.5.1. Module Imports
84.5.2. Module Includes
85. GPG
85.1. Authors
85.2. Summary of Module Globals
85.2.1.
85.2.2.
85.3. Global Functions
85.3.1. CreateKey
85.3.2. ExportAsciiPublicKey
85.3.3. ExportPublicKey
85.3.4. Init
85.3.5. PrivateKeys
85.3.6. PublicKeys
85.3.7. SignAsciiDetached
85.3.8. SignDetached
85.3.9. VerifyFile
85.4. Global Variables
85.5. Module Requirements
85.5.1. Module Imports
85.5.2. Module Includes
86. GPGWidgets
86.1. Authors
86.2. Summary of Module Globals
86.2.1.
86.2.2.
86.3. Global Functions
86.3.1. AskPassphrasePopup
86.3.2. AskPassphraseWidget
86.3.3. Passphrase
86.3.4. SelectedPrivateKey
86.3.5. SetSelectedPrivateKey
86.3.6. SetSelectedPublicKey
86.3.7. Widgets
86.4. Global Variables
86.5. Module Requirements
86.5.1. Module Imports
86.5.2. Module Includes
87. GetInstArgs
87.1. Authors
87.2. Summary of Module Globals
87.2.1.
87.2.2.
87.3. Global Functions
87.3.1. Buttons
87.3.2. ButtonsProposal
87.3.3. argmap
87.3.4. automatic_configuration
87.3.5. enable_back
87.3.6. enable_next
87.3.7. going_back
87.3.8. proposal
87.4. Global Variables
87.5. Module Requirements
88. GfxMenu
88.1. Authors
88.2. Summary of Module Globals
88.2.1.
88.2.2.
88.3. Global Functions
88.3.1. ReplaceRegexMatch
88.3.2. Update
88.3.3. UpdateGfxMenuContents
88.3.4. getTranslationsToDiacritics
88.3.5. translateSectionTitle
88.4. Global Variables
88.5. Module Requirements
88.5.1. Module Imports
88.5.2. Module Includes
89. Greasemonkey
89.1. Authors
89.2. Summary of Module Globals
89.2.1.
89.2.2.
89.3. Global Functions
89.4. Global Variables
89.5. Module Requirements
89.5.1. Module Imports
89.5.2. Module Includes
90. HTML
90.1. Authors
90.2. Summary of Module Globals
90.2.1.
90.2.2.
90.3. Global Functions
90.3.1. Bold
90.3.2. ColoredList
90.3.3. Colorize
90.3.4. Heading
90.3.5. Link
90.3.6. List
90.3.7. ListEnd
90.3.8. ListItem
90.3.9. ListStart
90.3.10. Newline
90.3.11. Newlines
90.3.12. Para
90.4. Global Variables
90.5. Module Requirements
91. HTTP
91.1. Authors
91.2. Summary of Module Globals
91.2.1.
91.2.2.
91.3. Global Functions
91.3.1. Get
91.3.2. Post
91.3.3. setUserPassword
91.4. Global Variables
91.5. Module Requirements
92. HWConfig
92.1. Authors
92.2. Summary of Module Globals
92.2.1.
92.2.2.
92.3. Global Functions
92.3.1. ConfigFiles
92.3.2. Flush
92.3.3. GetComment
92.3.4. GetValue
92.3.5. RemoveConfig
92.3.6. SetComment
92.3.7. SetValue
92.3.8. Values
92.3.9. Variables
92.4. Global Variables
92.5. Module Requirements
93. Heartbeat
93.1. Authors
93.2. Summary of Module Globals
93.2.1.
93.2.2.
93.3. Global Functions
93.3.1. Abort
93.3.2. AutoPackages
93.3.3. Export
93.3.4. Import
93.3.5. Modified
93.3.6. Modified
93.3.7. Overview
93.3.8. Read
93.3.9. Summary
93.3.10. Write
93.4. Global Variables
93.4.1. proposal_valid
93.4.2. write_only
93.5. Module Requirements
93.5.1. Module Imports
93.5.2. Module Includes
94. Hooks
94.1. Authors
94.2. Summary of Module Globals
94.2.1.
94.2.2.
94.3. Global Functions
94.3.1. Checkpoint
94.3.2. Run
94.4. Global Variables
94.5. Module Requirements
94.5.1. Module Imports
94.5.2. Module Includes
95. Host
95.1. Authors
95.2. Summary of Module Globals
95.2.1.
95.2.2.
95.3. Global Functions
95.3.1. Export
95.3.2. GetModified
95.3.3. GetSystemHosts
95.3.4. Import
95.3.5. Read
95.3.6. SetModified
95.3.7. Summary
95.3.8. Update
95.3.9. Write
95.4. Global Variables
95.4.1. hosts
95.4.2. modified
95.4.3. write_only
95.5. Module Requirements
95.5.1. Module Imports
95.5.2. Module Includes
96. Hostname
96.1. Authors
96.2. Summary of Module Globals
96.2.1.
96.2.2.
96.3. Global Functions
96.3.1. Check
96.3.2. CheckDomain
96.3.3. CheckFQ
96.3.4. CurrentDomain
96.3.5. CurrentFQ
96.3.6. CurrentHostname
96.3.7. MergeFQ
96.3.8. SplitFQ
96.3.9. ValidDomain
96.3.10. ValidFQ
96.3.11. ValidHost
96.4. Global Variables
96.4.1. ValidChars
96.5. Module Requirements
96.5.1. Module Imports
96.5.2. Module Includes
97. Hotplug
97.1. Authors
97.2. Summary of Module Globals
97.2.1.
97.2.2.
97.3. Global Functions
97.3.1. StartFireWire
97.3.2. StartUSB
97.4. Global Variables
97.4.1. haveFireWire
97.4.2. haveUSB
97.5. Module Requirements
97.5.1. Module Imports
97.5.2. Module Includes
98. HttpServer
98.1. Authors
98.2. Summary of Module Globals
98.2.1.
98.2.2.
98.3. Global Functions
98.3.1. AutoPackages
98.3.2. Export
98.3.3. Import
98.3.4. Modified
98.3.5. Read
98.3.6. Summary
98.3.7. Write
98.4. Global Variables
98.4.1. ip2device
98.4.2. modified
98.4.3. required_packages
98.4.4. write_only
98.5. Module Requirements
98.5.1. Module Imports
98.5.2. Module Includes
99. HwStatus
99.1. Authors
99.2. Summary of Module Globals
99.2.1.
99.2.2.
99.3. Global Functions
99.3.1. Get
99.3.2. Save
99.3.3. Set
99.3.4. Update
99.4. Global Variables
99.5. Module Requirements
100. IP
100.1. Authors
100.2. Summary of Module Globals
100.2.1.
100.2.2.
100.3. Global Functions
100.3.1. BitsToIPv4
100.3.2. Check
100.3.3. Check4
100.3.4. Check6
100.3.5. ComputeBroadcast
100.3.6. ComputeNetwork
100.3.7. IPv4ToBits
100.3.8. ToHex
100.3.9. ToInteger
100.3.10. ToString
100.3.11. Valid4
100.4. Global Variables
100.5. Module Requirements
101. ISDN
101.1. Authors
101.2. Summary of Module Globals
101.2.1.
101.2.2.
101.3. Global Functions
101.3.1. CountIF
101.3.2. Export
101.3.3. Import
101.3.4. Locate
101.3.5. Modified
101.3.6. NetDeviceList
101.3.7. OverviewDev
101.3.8. PrepareInterface
101.3.9. Read
101.3.10. SelectInterface
101.3.11. Summary
101.3.12. TestDev
101.3.13. Write
101.3.14. WriteOnly
101.4. Global Variables
101.4.1. AbortFunction
101.4.2. ISDNCDB
101.4.3. have_dsl
101.4.4. hw_device
101.4.5. interface
101.4.6. operation
101.4.7. skip
101.5. Module Requirements
101.5.1. Module Imports
101.5.2. Module Includes
102. ISSLEconfig
102.1. Authors
102.2. Summary of Module Globals
102.2.1.
102.2.2.
102.3. Global Functions
102.4. Global Variables
102.5. Module Requirements
103. Icon
103.1. Authors
103.2. Summary of Module Globals
103.2.1.
103.2.2.
103.3. Global Functions
103.3.1. Error
103.3.2. IconPath
103.3.3. Image
103.3.4. Info
103.3.5. Simple
103.3.6. Warning
103.4. Global Variables
103.5. Module Requirements
103.5.1. Module Imports
103.5.2. Module Includes
104. Idedma
104.1. Authors
104.2. Summary of Module Globals
104.2.1.
104.2.2.
104.3. Global Functions
104.3.1. Export
104.3.2. Import
104.3.3. Read
104.3.4. Set
104.3.5. Summary
104.3.6. Write
104.3.7. get_device_dma_status
104.3.8. get_ide_devices
104.3.9. selected_mode
104.3.10. set_dma
104.3.11. set_test_data
104.3.12. supported_dma_modes
104.4. Global Variables
104.4.1. dma_default_string
104.4.2. dma_off_string
104.4.3. dma_on_string
104.5. Module Requirements
104.5.1. Module Imports
104.5.2. Module Includes
105. ImageInstallation
105.1. Authors
105.2. Summary of Module Globals
105.2.1.
105.2.2.
105.3. Global Functions
105.3.1. CleanTemporaryImage
105.3.2. DeployImage
105.3.3. DeployImageTemporarily
105.3.4. DeployImages
105.3.5. FileSystemCopy
105.3.6. FillUpImagesDetails
105.3.7. FindImageSet
105.3.8. ImageOrder
105.3.9. ImagesToUse
105.3.10. SetRepo
105.3.11. StoreAllChanges
105.3.12. SwMgmtImage
105.4. Global Variables
105.5. Module Requirements
105.5.1. Module Imports
105.5.2. Module Includes
106. Inetd
106.1. Authors
106.2. Summary of Module Globals
106.2.1.
106.2.2.
106.3. Global Functions
106.3.1. Abort
106.3.2. AutoPackages
106.3.3. Export
106.3.4. Import
106.3.5. MergeAyProfile
106.3.6. MergeEditedWithSystem
106.3.7. Modified
106.3.8. Read
106.3.9. SafeRemove
106.3.10. Summary
106.3.11. Write
106.3.12. WriteOnly
106.3.13. addLine
106.3.14. changeLine
106.3.15. deleteLine
106.3.16. getChanged
106.3.17. mergeAfterInstall
106.3.18. mergeWithDefaults
106.3.19. mkeServiceSummary
106.4. Global Variables
106.4.1. AbortFunction
106.4.2. auto_mode
106.4.3. autoyast_initialized
106.4.4. last_created
106.4.5. modified
106.4.6. netd_conf
106.4.7. netd_status
106.4.8. proposal_valid
106.4.9. write_only
106.5. Module Requirements
106.5.1. Module Imports
106.5.2. Module Includes
107. InitHWinfo
107.1. Authors
107.2. Summary of Module Globals
107.2.1.
107.2.2.
107.3. Global Functions
107.3.1. DetectedHardware
107.3.2. Initialize
107.3.3. MakeProposal
107.4. Global Variables
107.5. Module Requirements
107.5.1. Module Imports
107.5.2. Module Includes
108. Initrd
108.1. Authors
108.2. Summary of Module Globals
108.2.1.
108.2.2.
108.3. Global Functions
108.3.1. AddModule
108.3.2. AdditionalParameters
108.3.3. Export
108.3.4. Import
108.3.5. ListModules
108.3.6. Read
108.3.7. RemoveModule
108.3.8. Reset
108.3.9. SetAdditionalParameters
108.3.10. Update
108.3.11. Write
108.3.12. errorWithLogPopup
108.3.13. getModulesToSkip
108.3.14. setSplash
108.4. Global Variables
108.4.1. changed
108.5. Module Requirements
108.5.1. Module Imports
108.5.2. Module Includes
109. InstData
109.1. Authors
109.2. Summary of Module Globals
109.2.1.
109.2.2.
109.3. Global Functions
109.4. Global Variables
109.5. Module Requirements
109.5.1. Module Imports
109.5.2. Module Includes
110. InstExtensionImage
110.1. Authors
110.2. Summary of Module Globals
110.2.1.
110.2.2.
110.3. Global Functions
110.3.1. LoadExtension
110.3.2. UnLoadExtension
110.4. Global Variables
110.5. Module Requirements
110.5.1. Module Imports
110.5.2. Module Includes
111. InstShowInfo
111.1. Authors
111.2. Summary of Module Globals
111.2.1.
111.2.2.
111.3. Global Functions
111.4. Global Variables
111.5. Module Requirements
111.5.1. Module Imports
111.5.2. Module Includes
112. InstURL
112.1. Authors
112.2. Summary of Module Globals
112.2.1.
112.2.2.
112.3. Global Functions
112.3.1. HidePassword
112.3.2. RewriteCDUrl
112.3.3. installInf2Url
112.4. Global Variables
112.5. Module Requirements
112.5.1. Module Imports
112.5.2. Module Includes
113. Installation
113.1. Authors
113.2. Summary of Module Globals
113.2.1.
113.2.2.
113.3. Global Functions
113.3.1. boot
113.3.2. no_x11
113.3.3. text_fallback
113.3.4. x11_setup_needed
113.4. Global Variables
113.4.1. image_installation
113.4.2. image_only
113.4.3. installedVersion
113.4.4. license_accepted
113.4.5. updateVersion
113.5. Module Requirements
113.5.1. Module Imports
113.5.2. Module Includes
114. Instserver
114.1. Authors
114.2. Summary of Module Globals
114.2.1.
114.2.2.
114.3. Global Functions
114.3.1. Abort
114.3.2. Export
114.3.3. Import
114.3.4. Instserver
114.3.5. Modified
114.3.6. Modified
114.3.7. Overview
114.3.8. Read
114.3.9. SetupFTP
114.3.10. SetupHTTP
114.3.11. SetupNFS
114.3.12. Summary
114.3.13. Write
114.3.14. WriteSLPReg
114.3.15. configSetup
114.3.16. createLinks
114.3.17. createOrderFiles
114.4. Global Variables
114.4.1. AbortFunction
114.4.2. modified
114.5. Module Requirements
114.5.1. Module Imports
114.5.2. Module Includes
115. Integer
115.1. Authors
115.2. Summary of Module Globals
115.2.1.
115.2.2.
115.3. Global Functions
115.3.1. Clamp
115.3.2. IsPowerOfTwo
115.3.3. Max
115.3.4. Min
115.3.5. Range
115.3.6. RangeFrom
115.3.7. Sum
115.4. Global Variables
115.5. Module Requirements
116. Internet
116.1. Authors
116.2. Summary of Module Globals
116.2.1.
116.2.2.
116.3. Global Functions
116.3.1. Connected
116.3.2. GetDevices
116.3.3. Reset
116.3.4. SetDemand
116.3.5. ShutdownAllLocalDHCPClients
116.3.6. Start
116.3.7. Status
116.3.8. Stop
116.4. Global Variables
116.4.1. device
116.4.2. do_test
116.4.3. do_you
116.4.4. suse_register
116.5. Module Requirements
116.5.1. Module Imports
116.5.2. Module Includes
117. InternetDevices
117.1. Authors
117.2. Summary of Module Globals
117.2.1.
117.2.2.
117.3. Global Functions
117.3.1. FindFastest
117.3.2. SetDevice
117.4. Global Variables
117.5. Module Requirements
117.5.1. Module Imports
117.5.2. Module Includes
118. Irda
118.1. Authors
118.2. Summary of Module Globals
118.2.1.
118.2.2.
118.3. Global Functions
118.3.1. Read
118.3.2. ReadSysconfig
118.3.3. Write
118.4. Global Variables
118.4.1. max_baud_rate
118.4.2. modified
118.4.3. port
118.4.4. start
118.5. Module Requirements
118.5.1. Module Imports
118.5.2. Module Includes
119. IscsiClient
119.1. Authors
119.2. Summary of Module Globals
119.2.1.
119.2.2.
119.3. Global Functions
119.3.1. Abort
119.3.2. AutoPackages
119.3.3. Export
119.3.4. Import
119.3.5. Modified
119.3.6. Modified
119.3.7. Overview
119.3.8. Read
119.3.9. Summary
119.3.10. Write
119.4. Global Variables
119.4.1. modified
119.4.2. proposal_valid
119.4.3. write_only
119.5. Module Requirements
119.5.1. Module Imports
119.5.2. Module Includes
120. IscsiClientLib
120.1. Authors
120.2. Summary of Module Globals
120.2.1.
120.2.2.
120.3. Global Functions
120.3.1. getiBFT
120.3.2. writeInitiatorName
120.4. Global Variables
120.5. Module Requirements
120.5.1. Module Imports
120.5.2. Module Includes
121. IscsiServer
121.1. Authors
121.2. Summary of Module Globals
121.2.1.
121.2.2.
121.3. Global Functions
121.3.1. Abort
121.3.2. AutoPackages
121.3.3. Export
121.3.4. Import
121.3.5. Modified
121.3.6. Modified
121.3.7. Overview
121.3.8. Read
121.3.9. Summary
121.3.10. Write
121.4. Global Variables
121.4.1. modified
121.4.2. proposal_valid
121.4.3. write_only
121.5. Module Requirements
121.5.1. Module Imports
121.5.2. Module Includes
122. isnsServer
122.1. Authors
122.2. Summary of Module Globals
122.2.1.
122.2.2.
122.3. Global Functions
122.3.1. Abort
122.3.2. AutoPackages
122.3.3. Modified
122.3.4. Modified
122.3.5. Read
122.3.6. Write
122.4. Global Variables
122.4.1. modified
122.4.2. proposal_valid
122.4.3. write_only
122.5. Module Requirements
122.5.1. Module Imports
122.5.2. Module Includes
123. Joystick
123.1. Authors
123.2. Summary of Module Globals
123.2.1.
123.2.2.
123.3. Global Functions
123.3.1. Changed
123.3.2. Export
123.3.3. Import
123.3.4. Read
123.3.5. RequiredKernelModules
123.3.6. SaveOneJoystick
123.3.7. StartAndEnable
123.3.8. Stop
123.3.9. Summary
123.3.10. Write
123.3.11. WriteConfig
123.4. Global Variables
123.4.1. joystick
123.5. Module Requirements
123.5.1. Module Imports
123.5.2. Module Includes
124. Kdump
124.1. Authors
124.2. Summary of Module Globals
124.2.1.
124.2.2.
124.3. Global Functions
124.3.1. Abort
124.3.2. CheckPackages
124.3.3. Export
124.3.4. GetModified
124.3.5. GetModified
124.3.6. Import
124.3.7. Propose
124.3.8. Read
124.3.9. SetModified
124.3.10. Summary
124.3.11. Write
124.4. Global Variables
124.4.1. DEFAULT_CONFIG
124.4.2. KDUMP_SETTINGS
124.4.3. actual_boot_section
124.4.4. add_crashkernel_param
124.4.5. alocated_memory
124.4.6. available_partitions
124.4.7. crashkernel_param_value
124.4.8. import_called
124.4.9. kdump_packages
124.4.10. modified
124.4.11. proposal_valid
124.4.12. propose_called
124.4.13. total_memory
124.4.14. uknown_fs_partitions
124.4.15. write_only
124.5. Module Requirements
124.5.1. Module Imports
124.5.2. Module Includes
125. Kerberos
125.1. Authors
125.2. Summary of Module Globals
125.2.1.
125.2.2.
125.3. Global Functions
125.3.1. AutoPackages
125.3.2. Export
125.3.3. Import
125.3.4. Modified
125.3.5. Read
125.3.6. ReadFile
125.3.7. ReadKrb5ConfValue
125.3.8. ReadKrb5ConfValues
125.3.9. ShortSummary
125.3.10. Summary
125.3.11. UpdatedArchPackages
125.3.12. ValidateTimeEntries
125.3.13. Write
125.3.14. WriteFile
125.3.15. WriteKrb5ConfValue
125.3.16. WriteKrb5ConfValues
125.3.17. WriteKrb5ConfValuesAsString
125.4. Global Variables
125.4.1. ExpertSettings
125.4.2. required_packages
125.5. Module Requirements
125.5.1. Module Imports
125.5.2. Module Includes
126. Kernel
126.1. Authors
126.2. Summary of Module Globals
126.2.1.
126.2.2.
126.3. Global Functions
126.3.1. AddCmdLine
126.3.2. AddModuleToLoad
126.3.3. ComputePackage
126.3.4. ComputePackages
126.3.5. ComputePackagesForBase
126.3.6. GetBinary
126.3.7. GetCmdLine
126.3.8. GetInformAboutKernelChange
126.3.9. GetPackages
126.3.10. GetSuSEUpdate
126.3.11. GetVgaType
126.3.12. ProbeKernel
126.3.13. RemoveModuleToLoad
126.3.14. SaveModulesToLoad
126.3.15. SetCmdLine
126.3.16. SetInformAboutKernelChange
126.3.17. SetVgaType
126.4. Global Variables
126.5. Module Requirements
126.5.1. Module Imports
126.5.2. Module Includes
127. KeyManager
127.1. Authors
127.2. Summary of Module Globals
127.2.1.
127.2.2.
127.3. Global Functions
127.3.1. DeleteKey
127.3.2. GetKeys
127.3.3. ImportFromFile
127.3.4. Modified
127.3.5. Read
127.3.6. Reset
127.3.7. SearchGPGKey
127.3.8. Write
127.4. Global Variables
127.5. Module Requirements
127.5.1. Module Imports
127.5.2. Module Includes
128. Keyboard
128.1. Authors
128.2. Summary of Module Globals
128.2.1.
128.2.2.
128.3. Global Functions
128.3.1. CalledRestore
128.3.2. CheckKeyboardDuringUpdate
128.3.3. Export
128.3.4. GetExpertValues
128.3.5. GetKeyboardForLanguage
128.3.6. GetKeyboardItems
128.3.7. GetX11KeyData
128.3.8. Import
128.3.9. Keyboard
128.3.10. MakeProposal
128.3.11. Modified
128.3.12. Name
128.3.13. Probe
128.3.14. Read
128.3.15. Restore
128.3.16. Save
128.3.17. Selection
128.3.18. Set
128.3.19. SetConsole
128.3.20. SetExpertValues
128.3.21. SetKeyboard
128.3.22. SetX11
128.3.23. Summary
128.3.24. get_lang2keyboard
128.3.25. keymap2yast
128.3.26. xf86_update
128.4. Global Variables
128.4.1. expert_on_entry
128.4.2. keyboard_on_entry
128.5. Module Requirements
128.5.1. Module Imports
128.5.2. Module Includes
129. Kickstart
129.1. Authors
129.2. Summary of Module Globals
129.2.1.
129.2.2.
129.3. Global Functions
129.3.1. KS2AY
129.3.2. Kickstart
129.3.3. Read
129.4. Global Variables
129.5. Module Requirements
129.5.1. Module Imports
129.5.2. Module Includes
130. Kiwi
130.1. Authors
130.2. Summary of Module Globals
130.2.1.
130.2.2.
130.3. Global Functions
130.3.1. ImportImageRepositories
130.3.2. InitCurrentRepositories
130.3.3. PrepareAndCreate
130.3.4. Read
130.3.5. ReadConfigXML
130.3.6. ReadImageTemplates
130.3.7. SaveConfiguration
130.3.8. WriteConfigXML
130.4. Global Variables
130.4.1. content_key
130.5. Module Requirements
130.5.1. Module Imports
130.5.2. Module Includes
131. Label
131.1. Authors
131.2. Summary of Module Globals
131.2.1.
131.2.2.
131.3. Global Functions
131.3.1. AbortButton
131.3.2. AbortInstallationButton
131.3.3. AcceptButton
131.3.4. AddButton
131.3.5. BackButton
131.3.6. BrowseButton
131.3.7. CancelButton
131.3.8. CloseButton
131.3.9. ConfirmPassword
131.3.10. ContinueButton
131.3.11. CreateButton
131.3.12. DefaultFunctionKeyMap
131.3.13. DeleteButton
131.3.14. DoNotAcceptButton
131.3.15. DontInstallButton
131.3.16. DownButton
131.3.17. DownloadButton
131.3.18. EditButton
131.3.19. ErrorMsg
131.3.20. FileName
131.3.21. FinishButton
131.3.22. HelpButton
131.3.23. HostName
131.3.24. IgnoreButton
131.3.25. InstallButton
131.3.26. NewButton
131.3.27. NextButton
131.3.28. NoButton
131.3.29. OKButton
131.3.30. Options
131.3.31. Password
131.3.32. PleaseWaitMsg
131.3.33. Port
131.3.34. QuitButton
131.3.35. RefreshButton
131.3.36. RemoveButton
131.3.37. ReplaceButton
131.3.38. RetryButton
131.3.39. SaveButton
131.3.40. SelectButton
131.3.41. SkipButton
131.3.42. StopButton
131.3.43. UpButton
131.3.44. WarningMsg
131.3.45. YesButton
131.4. Global Variables
131.5. Module Requirements
132. Lan
132.1. Authors
132.2. Summary of Module Globals
132.2.1.
132.2.2.
132.3. Global Functions
132.3.1. Add
132.3.2. AnyDHCPDevice
132.3.3. AutoPackages
132.3.4. Autoinstall
132.3.5. Delete
132.3.6. Edit
132.3.7. Export
132.3.8. HaveXenBridge
132.3.9. Import
132.3.10. Packages
132.3.11. Propose
132.3.12. ProposeInterfaces
132.3.13. ProposeRoutesAndResolver
132.3.14. Read
132.3.15. ReadWithCache
132.3.16. Summary
132.3.17. SummaryGeneral
132.3.18. Write
132.3.19. WriteOnly
132.4. Global Variables
132.5. Module Requirements
132.5.1. Module Imports
132.5.2. Module Includes
133. LanItems
133.1. Authors
133.2. Summary of Module Globals
133.2.1.
133.2.2.
133.3. Global Functions
133.3.1. Commit
133.3.2. FindMatchingDevice
133.3.3. FreeAliases
133.3.4. FreeDevices
133.3.5. GetDefaultsForHW
133.3.6. GetModified
133.3.7. GetModuleForInterface
133.3.8. InterfaceHasAliases
133.3.9. Modified
133.3.10. Overview
133.3.11. Select
133.3.12. SelectHW
133.3.13. SelectHWMap
133.3.14. SetDefaultsForHW
133.3.15. SetDeviceVars
133.3.16. SetModified
133.3.17. UnsetModified
133.4. Global Variables
133.4.1. Items
133.4.2. SysconfigDefaults
133.4.3. modified
133.4.4. operation
133.4.5. wl_wpa_eap
133.5. Module Requirements
133.5.1. Module Imports
133.5.2. Module Includes
134. LanUdevAuto
134.1. Authors
134.2. Summary of Module Globals
134.2.1.
134.2.2.
134.3. Global Functions
134.4. Global Variables
134.5. Module Requirements
134.5.1. Module Imports
134.5.2. Module Includes
135. Language
135.1. Authors
135.2. Summary of Module Globals
135.2.1.
135.2.2.
135.3. Global Functions
135.3.1. CJKLanguage
135.3.2. CheckIncompleteTranslation
135.3.3. CheckLanguagesSupport
135.3.4. Export
135.3.5. GetExpertValues
135.3.6. GetLang2KeyboardMap
135.3.7. GetLang2TimezoneMap
135.3.8. GetLanguageCountry
135.3.9. GetLanguagesMap
135.3.10. GetLocaleString
135.3.11. GetLocales
135.3.12. GetName
135.3.13. GetTextMode
135.3.14. Import
135.3.15. IncompleteTranslation
135.3.16. Language
135.3.17. MakeProposal
135.3.18. MakeSimpleProposal
135.3.19. Modified
135.3.20. PackagesInit
135.3.21. PackagesModified
135.3.22. QuickSet
135.3.23. Read
135.3.24. ReadSysconfigLanguage
135.3.25. ReadSysconfigValues
135.3.26. Save
135.3.27. Selection
135.3.28. Set
135.3.29. SetDefault
135.3.30. SetExpertValues
135.3.31. Summary
135.3.32. WfmSetGivenLanguage
135.3.33. WfmSetLanguage
135.4. Global Variables
135.4.1. language
135.4.2. language_on_entry
135.4.3. languages
135.4.4. languages_on_entry
135.4.5. preselected
135.4.6. selection_skipped
135.5. Module Requirements
135.5.1. Module Imports
135.5.2. Module Includes
136. Ldap
136.1. Authors
136.2. Summary of Module Globals
136.2.1.
136.2.2.
136.3. Global Functions
136.3.1. AddMissingAttributes
136.3.2. AttributeDescription
136.3.3. AutoPackages
136.3.4. BaseDNChanged
136.3.5. CheckBaseConfig
136.3.6. CheckNDS
136.3.7. CheckOES
136.3.8. CheckOrderOfCreation
136.3.9. CheckTemplateDN
136.3.10. CommitConfigModules
136.3.11. CommitTemplates
136.3.12. ConnectWithoutTLS
136.3.13. ConvertDefaultValues
136.3.14. CreateModule
136.3.15. CreateTemplate
136.3.16. Export
136.3.17. GetAllAttributes
136.3.18. GetBaseDN
136.3.19. GetBindDN
136.3.20. GetConfigModules
136.3.21. GetDefaultObjectClasses
136.3.22. GetGroupsDN
136.3.23. GetLDAPEntry
136.3.24. GetLDAPPassword
136.3.25. GetMainConfigDN
136.3.26. GetObjectAttributes
136.3.27. GetRequiredAttributes
136.3.28. GetTemplates
136.3.29. Import
136.3.30. InitSchema
136.3.31. LDAPAskAndBind
136.3.32. LDAPBind
136.3.33. LDAPError
136.3.34. LDAPErrorMap
136.3.35. LDAPErrorMessage
136.3.36. LDAPInit
136.3.37. LDAPInitWithTLSCheck
136.3.38. ObjectClassExists
136.3.39. ObjectClassStructural
136.3.40. ParentExists
136.3.41. Read
136.3.42. ReadConfigModules
136.3.43. ReadDN
136.3.44. ReadTemplates
136.3.45. RestartSSHD
136.3.46. Set
136.3.47. SetAnonymous
136.3.48. SetBaseDN
136.3.49. SetBindPassword
136.3.50. SetDefaults
136.3.51. SetGUI
136.3.52. SetReadSettings
136.3.53. ShortSummary
136.3.54. SingleValued
136.3.55. Summary
136.3.56. UpdatedArchPackages
136.3.57. Write
136.3.58. WriteLDAP
136.3.59. WriteNow
136.3.60. WriteOpenLdapConf
136.3.61. WritePlusLine
136.3.62. WriteToLDAP
136.4. Global Variables
136.4.1. _autofs_allowed
136.4.2. _start_autofs
136.4.3. attr_types
136.4.4. available_config_modules
136.4.5. base_config_dn
136.4.6. bind_dn
136.4.7. file_server
136.4.8. hash_schemas
136.4.9. initial_defaults
136.4.10. initial_defaults_used
136.4.11. login_enabled
136.4.12. member_attribute
136.4.13. mkhomedir
136.4.14. new_objects
136.4.15. nis_available
136.4.16. object_classes
136.4.17. read_settings
136.4.18. required_packages
136.4.19. restart_sshd
136.4.20. server
136.4.21. start
136.4.22. use_gui
136.4.23. write_only
136.5. Module Requirements
136.5.1. Module Imports
136.5.2. Module Includes
137. LdapDatabase
137.1. Authors
137.2. Summary of Module Globals
137.2.1.
137.2.2.
137.3. Global Functions
137.4. Global Variables
137.5. Module Requirements
137.5.1. Module Imports
137.5.2. Module Includes
138. LdapPopup
138.1. Authors
138.2. Summary of Module Globals
138.2.1.
138.2.2.
138.3. Global Functions
138.3.1. AddDefaultValue
138.3.2. BrowseTree
138.3.3. EditAttribute
138.3.4. InitAndBrowseTree
138.3.5. NewModule
138.3.6. PasswordPolicyDialog
138.4. Global Variables
138.5. Module Requirements
138.5.1. Module Imports
138.5.2. Module Includes
139. LinuxUserMgmt
139.1. Authors
139.2. Summary of Module Globals
139.2.1.
139.2.2.
139.3. Global Functions
139.3.1. Abort
139.3.2. AutoPackages
139.3.3. Export
139.3.4. Import
139.3.5. Modified
139.3.6. Modified
139.3.7. Overview
139.3.8. Read
139.3.9. Summary
139.3.10. Write
139.4. Global Variables
139.4.1. Settings
139.4.2. modified
139.4.3. proposal_valid
139.4.4. write_only
139.5. Module Requirements
139.5.1. Module Imports
139.5.2. Module Includes
140. Linuxrc
140.1. Authors
140.2. Summary of Module Globals
140.2.1.
140.2.2.
140.3. Global Functions
140.3.1. WriteYaSTInf
140.3.2. braille
140.3.3. display_ip
140.3.4. serial_console
140.3.5. text
140.3.6. usessh
140.3.7. vnc
140.4. Global Variables
140.5. Module Requirements
140.5.1. Module Imports
140.5.2. Module Includes
141. LiveInstaller
141.1. Authors
141.2. Summary of Module Globals
141.2.1.
141.2.2.
141.3. Global Functions
141.4. Global Variables
141.5. Module Requirements
142. LogView
142.1. Authors
142.2. Summary of Module Globals
142.2.1.
142.2.2.
142.3. Global Functions
142.3.1. AdvancedHelp
142.3.2. AdvancedSaveHelp
142.3.3. CreateWidget
142.3.4. Display
142.3.5. DisplayFiltered
142.3.6. DisplaySimple
142.3.7. LogHandle
142.3.8. LogInit
142.3.9. LogSelectionHelp
142.3.10. SaveHelp
142.3.11. SingleLogHelp
142.4. Global Variables
142.5. Module Requirements
142.5.1. Module Imports
142.5.2. Module Includes
143. LogViewCore.ycp
143.1. Authors
143.2. Summary of Module Globals
143.2.1.
143.2.2.
143.3. Global Functions
143.3.1. Start
143.4. Global Variables
143.5. Module Requirements
143.5.1. Module Imports
143.5.2. Module Includes
144. Mail
144.1. Authors
144.2. Summary of Module Globals
144.2.1.
144.2.2.
144.3. Global Functions
144.3.1. AutoPackages
144.3.2. CreateConfig
144.3.3. Export
144.3.4. Fake
144.3.5. Import
144.3.6. ProbePackages
144.3.7. Read
144.3.8. Summary
144.3.9. Touch
144.3.10. Write
144.4. Global Variables
144.4.1. amavis_allowed
144.4.2. connection_type
144.4.3. fetchmail
144.4.4. fetchmail_mode
144.4.5. from_header
144.4.6. install_packages
144.4.7. listen_remote
144.4.8. local_domains
144.4.9. masquerade_other_domains
144.4.10. masquerade_users
144.4.11. mta
144.4.12. outgoing_mail_server
144.4.13. postfix_mda
144.4.14. protocol_choices
144.4.15. remove_packages
144.4.16. required_packages
144.4.17. smtp_auth
144.4.18. smtp_use_TLS
144.4.19. touched
144.4.20. use_amavis
144.4.21. virtual_users
144.4.22. write_only
144.5. Module Requirements
144.5.1. Module Imports
144.5.2. Module Includes
145. MailAliases
145.1. Authors
145.2. Summary of Module Globals
145.2.1.
145.2.2.
145.3. Global Functions
145.3.1. FilterRootAlias
145.3.2. GetRootAlias
145.3.3. MergeRootAlias
145.3.4. ReadAliases
145.3.5. SetRootAlias
145.3.6. WriteAliases
145.4. Global Variables
145.4.1. aliases
145.4.2. root_alias
145.5. Module Requirements
145.5.1. Module Imports
145.5.2. Module Includes
146. MailServer
146.1. Authors
146.2. Summary of Module Globals
146.2.1.
146.2.2.
146.3. Global Functions
146.3.1. Abort
146.3.2. AutoPackages
146.3.3. CheckPackages
146.3.4. Export
146.3.5. Import
146.3.6. Modified
146.3.7. Modified
146.3.8. Overview
146.3.9. Read
146.3.10. Summary
146.3.11. Write
146.4. Global Variables
146.4.1. AdminPassword
146.4.2. CertExist
146.4.3. FetchingMail
146.4.4. GlobalSettings
146.4.5. LDAPDefaults
146.4.6. MailLocalDelivery
146.4.7. MailLocalDomains
146.4.8. MailPrevention
146.4.9. MailRelaying
146.4.10. MailTransports
146.4.11. ModulesTreeContent
146.4.12. PPPCards
146.4.13. modified
146.4.14. proposal_valid
146.4.15. setup
146.4.16. write_only
146.5. Module Requirements
146.5.1. Module Imports
146.5.2. Module Includes
147. Map
147.1. Authors
147.2. Summary of Module Globals
147.2.1.
147.2.2.
147.3. Global Functions
147.3.1. CheckKeys
147.3.2. FromString
147.3.3. Keys
147.3.4. KeysToLower
147.3.5. KeysToUpper
147.3.6. ToString
147.3.7. Values
147.4. Global Variables
147.5. Module Requirements
147.5.1. Module Imports
147.5.2. Module Includes
148. Message
148.1. Authors
148.2. Summary of Module Globals
148.2.1.
148.2.2.
148.3. Global Functions
148.3.1. CannotAdjustService
148.3.2. CannotContinueWithoutPackagesInstalled
148.3.3. CannotOpenFile
148.3.4. CannotOpenFileBecause
148.3.5. CannotReadCurrentSettings
148.3.6. CannotRestartService
148.3.7. CannotStartService
148.3.8. CannotStopService
148.3.9. CannotWriteSettingsTo
148.3.10. CannotWriteSettingsToBecause
148.3.11. CheckEnvironment
148.3.12. DirectoryDoesNotExistCreate
148.3.13. DoNotShowMessageAgain
148.3.14. DomainHasChangedMustReboot
148.3.15. ErrorWritingFile
148.3.16. ErrorWritingFileBecause
148.3.17. FailedToInstallPackages
148.3.18. Finished
148.3.19. MissingParameter
148.3.20. RequiredItem
148.3.21. SuSEConfigFailed
148.3.22. UnableToCreateDirectory
148.3.23. UnknownError
148.4. Global Variables
148.5. Module Requirements
149. MiniWorkflow
149.1. Authors
149.2. Summary of Module Globals
149.2.1.
149.2.2.
149.3. Global Functions
149.4. Global Variables
149.5. Module Requirements
149.5.1. Module Imports
149.5.2. Module Includes
150. Misc
150.1. Authors
150.2. Summary of Module Globals
150.2.1.
150.2.2.
150.3. Global Functions
150.3.1. CustomSysconfigRead
150.3.2. ReadAlternateFile
150.3.3. SplitOptions
150.3.4. SysconfigRead
150.3.5. SysconfigWrite
150.3.6. hardware_name
150.3.7. translate
150.4. Global Variables
150.5. Module Requirements
151. Mode
151.1. Authors
151.2. Summary of Module Globals
151.2.1.
151.2.2.
151.3. Global Functions
151.3.1. Initialize
151.3.2. autoinst
151.3.3. commandline
151.3.4. config
151.3.5. installation
151.3.6. live_installation
151.3.7. mode
151.3.8. normal
151.3.9. repair
151.3.10. screen_shot
151.3.11. test
151.3.12. testsuite
151.3.13. ui
151.3.14. update
151.4. Global Variables
151.5. Module Requirements
152. Modem
152.1. Authors
152.2. Summary of Module Globals
152.2.1.
152.2.2.
152.3. Global Functions
152.3.1. Add
152.3.2. Adding
152.3.3. Commit
152.3.4. Delete
152.3.5. Edit
152.3.6. Export
152.3.7. Import
152.3.8. Modified
152.3.9. Overview
152.3.10. Read
152.3.11. Select
152.3.12. SelectHW
152.3.13. Summary
152.3.14. Write
152.4. Global Variables
152.4.1. AbortFunction
152.4.2. hotplug
152.5. Module Requirements
152.5.1. Module Imports
152.5.2. Module Includes
153. ModuleLoading
153.1. Authors
153.2. Summary of Module Globals
153.2.1.
153.2.2.
153.3. Global Functions
153.3.1. Load
153.3.2. prepareVendorDeviceInfo
153.4. Global Variables
153.5. Module Requirements
153.5.1. Module Imports
153.5.2. Module Includes
154. ModulesComments
154.1. Authors
154.2. Summary of Module Globals
154.2.1.
154.2.2.
154.3. Global Functions
154.3.1. ExtractFromComment
154.3.2. StoreToComment
154.4. Global Variables
154.5. Module Requirements
155. ModulesConf
155.1. Authors
155.2. Summary of Module Globals
155.2.1.
155.2.2.
155.3. Global Functions
155.3.1. ModuleArgs
155.3.2. RunDepmod
155.3.3. Save
155.4. Global Variables
155.5. Module Requirements
155.5.1. Module Imports
155.5.2. Module Includes
156. Mouse
156.1. Authors
156.2. Summary of Module Globals
156.2.1.
156.2.2.
156.3. Global Functions
156.4. Global Variables
156.5. Module Requirements
156.5.1. Module Imports
156.5.2. Module Includes
157. Multipath
157.1. Authors
157.2. Summary of Module Globals
157.2.1.
157.2.2.
157.3. Global Functions
157.3.1. Abort
157.3.2. Read
157.3.3. ReadDialog
157.3.4. Write
157.3.5. WriteDialog
157.4. Global Variables
157.5. Module Requirements
157.5.1. Module Imports
157.5.2. Module Includes
158. NetHwDetection
158.1. Authors
158.2. Summary of Module Globals
158.2.1.
158.2.2.
158.3. Global Functions
158.3.1. DuplicateIP
158.3.2. ResolveIP
158.3.3. Start
158.3.4. Stop
158.4. Global Variables
158.4.1. result
158.4.2. running
158.5. Module Requirements
158.5.1. Module Imports
158.5.2. Module Includes
159. Netmask
159.1. Authors
159.2. Summary of Module Globals
159.2.1.
159.2.2.
159.3. Global Functions
159.3.1. Check
159.3.2. Check4
159.3.3. Check6
159.3.4. FromBits
159.3.5. ToBits
159.4. Global Variables
159.5. Module Requirements
160. Network
160.1. Authors
160.2. Summary of Module Globals
160.2.1.
160.2.2.
160.3. Global Functions
160.4. Global Variables
160.5. Module Requirements
160.5.1. Module Imports
160.5.2. Module Includes
161. NetworkConfig
161.1. Authors
161.2. Summary of Module Globals
161.2.1.
161.2.2.
161.3. Global Functions
161.3.1. Export
161.3.2. Import
161.3.3. Modified
161.3.4. Read
161.3.5. Write
161.4. Global Variables
161.4.1. Config
161.4.2. DHCP
161.5. Module Requirements
161.5.1. Module Imports
161.5.2. Module Includes
162. NetworkInterfaces
162.1. Authors
162.2. Summary of Module Globals
162.2.1.
162.2.2.
162.3. Global Functions
162.3.1. Add
162.3.2. CanonicalizeIP
162.3.3. CanonicalizeStartmode
162.3.4. Check
162.3.5. CleanCacheRead
162.3.6. CleanHotplugSymlink
162.3.7. ConcealSecrets
162.3.8. ConcealSecrets1
162.3.9. Delete
162.3.10. DeleteAlias
162.3.11. Edit
162.3.12. Export
162.3.13. Fastest
162.3.14. FilterDevices
162.3.15. GetDevTypeDescription
162.3.16. GetDeviceType
162.3.17. GetDeviceTypes
162.3.18. GetFreeDevice
162.3.19. GetFreeDevicesOld
162.3.20. GetIP
162.3.21. HasAliases
162.3.22. Import
162.3.23. IsConnected
162.3.24. IsHotplug
162.3.25. List
162.3.26. ListDevicesExcept
162.3.27. Locate
162.3.28. LocateNOT
162.3.29. LocateProvider
162.3.30. Modified
162.3.31. Push
162.3.32. Read
162.3.33. RealType
162.3.34. Select
162.3.35. UpdateModemSymlink
162.3.36. ValidCharsIfcfg
162.3.37. Write
162.3.38. alias_name
162.3.39. alias_num
162.3.40. device_name
162.3.41. device_num
162.3.42. device_type
162.4. Global Variables
162.4.1. CardRegex
162.4.2. Current
162.4.3. DeviceRegex
162.4.4. Name
162.4.5. report_every_check
162.5. Module Requirements
162.5.1. Module Imports
162.5.2. Module Includes
163. NetworkPopup
163.1. Authors
163.2. Summary of Module Globals
163.2.1.
163.2.2.
163.3. Global Functions
163.3.1. ChooseItem
163.3.2. HostName
163.3.3. NFSExport
163.3.4. NFSServer
163.4. Global Variables
163.5. Module Requirements
163.5.1. Module Imports
163.5.2. Module Includes
164. NetworkService
164.1. Authors
164.2. Summary of Module Globals
164.2.1.
164.2.2.
164.3. Global Functions
164.3.1. ConfirmNetworkManager
164.3.2. EnableDisable
164.3.3. IsManaged
164.3.4. Read
164.3.5. RunningNetworkPopup
164.3.6. SetManaged
164.3.7. StartStop
164.4. Global Variables
164.5. Module Requirements
164.5.1. Module Imports
164.5.2. Module Includes
165. NetworkStorage
165.1. Authors
165.2. Summary of Module Globals
165.2.1.
165.2.2.
165.3. Global Functions
165.3.1. isDiskOnNetwork
165.4. Global Variables
165.5. Module Requirements
165.5.1. Module Imports
165.5.2. Module Includes
166. NewID
166.1. Authors
166.2. Summary of Module Globals
166.2.1.
166.2.2.
166.3. Global Functions
166.3.1. Activate
166.3.2. MakeProposal
166.4. Global Variables
166.5. Module Requirements
166.5.1. Module Imports
166.5.2. Module Includes
167. Nfs
167.1. Authors
167.2. Summary of Module Globals
167.2.1.
167.2.2.
167.3. Global Functions
167.3.1. AutoPackages
167.3.2. Export
167.3.3. GetModified
167.3.4. Import
167.3.5. Mount
167.3.6. Read
167.3.7. Set
167.3.8. SetModified
167.3.9. Summary
167.3.10. Unmount
167.3.11. Write
167.3.12. WriteOnly
167.4. Global Variables
167.4.1. nfs_entries
167.4.2. non_nfs_entries
167.4.3. required_packages
167.5. Module Requirements
167.5.1. Module Imports
167.5.2. Module Includes
168. NfsServer
168.1. Authors
168.2. Summary of Module Globals
168.2.1.
168.2.2.
168.3. Global Functions
168.3.1. AutoPackages
168.3.2. Export
168.3.3. GetModified
168.3.4. Import
168.3.5. Read
168.3.6. Set
168.3.7. SetModified
168.3.8. Summary
168.3.9. Write
168.3.10. WriteExports
168.4. Global Variables
168.4.1. domain
168.4.2. enable_nfsv4
168.4.3. exports
168.4.4. nfs_security
168.4.5. required_packages
168.4.6. start
168.4.7. write_only
168.5. Module Requirements
168.5.1. Module Imports
168.5.2. Module Includes
169. Nis
169.1. Authors
169.2. Summary of Module Globals
169.2.1.
169.2.2.
169.3. Global Functions
169.3.1. AutoPackages
169.3.2. BrItem
169.3.3. DomainChanged
169.3.4. Export
169.3.5. Fake
169.3.6. GetDomain
169.3.7. GetModified
169.3.8. GetServers
169.3.9. Import
169.3.10. ProbePackages
169.3.11. Read
169.3.12. Set
169.3.13. SetDomain
169.3.14. SetModified
169.3.15. SetServers
169.3.16. ShortSummary
169.3.17. Summary
169.3.18. Touch
169.3.19. UsersByLdap
169.3.20. Write
169.3.21. WriteNssConf
169.3.22. WriteOnly
169.3.23. check_address_nis
169.3.24. check_nisdomainname
169.3.25. getNetconfigValues
169.3.26. setNetconfigValues
169.3.27. valid_address_nis
169.3.28. valid_nisdomainname
169.4. Global Variables
169.4.1. YpbindErrors
169.4.2. _autofs_allowed
169.4.3. _start_autofs
169.4.4. broken_server
169.4.5. default_broadcast
169.4.6. dhcp_restart
169.4.7. dhcpcd_running
169.4.8. global_broadcast
169.4.9. install_packages
169.4.10. local_only
169.4.11. multidomain_broadcast
169.4.12. multidomain_servers
169.4.13. options
169.4.14. required_packages
169.4.15. servers
169.4.16. start
169.4.17. touched
169.5. Module Requirements
169.5.1. Module Imports
169.5.2. Module Includes
170. NisServer
170.1. Authors
170.2. Summary of Module Globals
170.2.1.
170.2.2.
170.3. Global Functions
170.3.1. Client
170.3.2. EnsureDirectory
170.3.3. Export
170.3.4. GetAllMaps
170.3.5. GetModified
170.3.6. GetSaveList
170.3.7. Import
170.3.8. Read
170.3.9. Remove
170.3.10. SaveSecurenets
170.3.11. SaveSlaves
170.3.12. SaveVariables
170.3.13. SetModified
170.3.14. Summary
170.3.15. Write
170.3.16. YPDaemons
170.3.17. YPGetMaps
170.3.18. YPMake
170.3.19. addError
170.3.20. addErrorDetail
170.3.21. getMaster
170.3.22. isYPMaster
170.3.23. isYPServerInstalled
170.4. Global Variables
170.4.1. dhcp_changes_domain
170.4.2. domain
170.4.3. maps
170.4.4. merge_passwd
170.4.5. mingid
170.4.6. minuid
170.4.7. modified
170.4.8. nisclient_local
170.4.9. nopush
170.4.10. old_domainname
170.4.11. pwd_chfn
170.4.12. pwd_chsh
170.4.13. pwd_srcdir
170.4.14. required_packages
170.4.15. securenets
170.4.16. start_ypbind
170.4.17. start_yppasswdd
170.4.18. start_ypxfrd
170.4.19. ui_master_ip
170.4.20. ui_what
170.4.21. write_only
170.4.22. ypservers
170.5. Module Requirements
170.5.1. Module Imports
170.5.2. Module Includes
171. NovellCasa
171.1. Authors
171.2. Summary of Module Globals
171.2.1.
171.2.2.
171.3. Global Functions
171.3.1. Abort
171.3.2. AutoPackages
171.3.3. Export
171.3.4. Import
171.3.5. Modified
171.3.6. Modified
171.3.7. Overview
171.3.8. Read
171.3.9. Summary
171.3.10. Write
171.4. Global Variables
171.4.1. modified
171.4.2. proposal_valid
171.4.3. write_only
171.5. Module Requirements
171.5.1. Module Imports
171.5.2. Module Includes
172. NovellLDAPLUM
172.1. Authors
172.2. Summary of Module Globals
172.2.1.
172.2.2.
172.3. Global Functions
172.4. Global Variables
172.5. Module Requirements
172.5.1. Module Imports
172.5.2. Module Includes
173. NovellUtilsLUM
173.1. Authors
173.2. Summary of Module Globals
173.2.1.
173.2.2.
173.3. Global Functions
173.3.1. CheckForInstalledSoftware
173.3.2. FindValueInRegistry
173.3.3. GetDefaultAndFallbackIPAddresses
173.3.4. GetIPAddr
173.3.5. IsEdirectoryInstalledLocally
173.3.6. IsSelectionInstalled
173.3.7. MapIPAddrToDevice
173.3.8. ReplaceSubString
173.3.9. Typeful2Typeless
173.3.10. ValidatePassword
173.4. Global Variables
173.5. Module Requirements
173.5.1. Module Imports
173.5.2. Module Includes
174. NovellValidatorsLUM
174.1. Authors
174.2. Summary of Module Globals
174.2.1.
174.2.2.
174.3. Global Functions
174.3.1. ValidateContext
174.3.2. ValidateCredentials
174.3.3. ValidateDNSorIP
174.3.4. ValidateFDN
174.3.5. ValidateIP
174.3.6. ValidateIPMsg
174.3.7. ValidatePassword
174.3.8. ValidatePasswords
174.3.9. ValidatePort
174.4. Global Variables
174.5. Module Requirements
174.5.1. Module Imports
174.5.2. Module Includes
175. Nsswitch
175.1. Authors
175.2. Summary of Module Globals
175.2.1.
175.2.2.
175.3. Global Functions
175.3.1. ReadDb
175.3.2. Write
175.3.3. WriteAutofs
175.3.4. WriteDb
175.4. Global Variables
175.5. Module Requirements
175.5.1. Module Imports
175.5.2. Module Includes
176. NtpClient
176.1. Authors
176.2. Summary of Module Globals
176.2.1.
176.2.2.
176.3. Global Functions
176.3.1. ActivateRandomPoolServersFunction
176.3.2. AutoPackages
176.3.3. DeActivateRandomPoolServersFunction
176.3.4. DetectNtpServers
176.3.5. Export
176.3.6. GetAllKnownCountries
176.3.7. GetCountryNames
176.3.8. GetCurrentLanguageCode
176.3.9. GetNtpServers
176.3.10. GetNtpServersByCountry
176.3.11. GetUsedNtpServers
176.3.12. Import
176.3.13. IsRandomServersServiceEnabled
176.3.14. ProcessNtpConf
176.3.15. Read
176.3.16. Summary
176.3.17. TestNtpServer
176.3.18. Write
176.3.19. deleteSyncRecord
176.3.20. findSyncRecord
176.3.21. getSyncRecords
176.3.22. selectSyncRecord
176.3.23. storeSyncRecord
176.4. Global Variables
176.4.1. ad_controller
176.4.2. change_firewall
176.4.3. firewall_services
176.4.4. modified
176.4.5. ntp_policy
176.4.6. ntp_records
176.4.7. random_pool_servers
176.4.8. required_packages
176.4.9. run_chroot
176.4.10. run_service
176.4.11. selected_index
176.4.12. selected_record
176.4.13. service_name
176.4.14. write_only
176.5. Module Requirements
176.5.1. Module Imports
176.5.2. Module Includes
177. OSR
177.1. Authors
177.2. Summary of Module Globals
177.2.1.
177.2.2.
177.3. Global Functions
177.3.1. CheckGroupRequires
177.3.2. Detect
177.3.3. DetectGroupList
177.3.4. GroupItems
177.3.5. Init
177.3.6. Reset
177.3.7. ResetDetect
177.3.8. ResetDetectGroupList
177.3.9. ResetDetectionModules
177.3.10. SetDetectGroupList
177.3.11. SetReboot
177.3.12. SizeDetectGroupList
177.3.13. osr_empty
177.4. Global Variables
177.4.1. next_detect_method
177.5. Module Requirements
177.5.1. Module Imports
177.5.2. Module Includes
178. OSRBoot
178.1. Authors
178.2. Summary of Module Globals
178.2.1.
178.2.2.
178.3. Global Functions
178.3.1. BootloaderPackages
178.3.2. CheckConfig
178.3.3. CheckInitrdModules
178.3.4. CheckLoaderPackages
178.3.5. CheckSysconfigFiles
178.3.6. ExistsConf
178.3.7. InstallLoaderPackage
178.3.8. InstallNewLoader
178.3.9. PackageVersionStrings
178.3.10. RepairConfig
178.3.11. RepairInitrdModules
178.3.12. RepairSysconfigFiles
178.3.13. Reset
178.3.14. VersionIsHigherOrEqual
178.3.15. repair_grub_config
178.3.16. sectOptions2Map
178.4. Global Variables
178.4.1. boot_device
178.4.2. missing_packages
178.4.3. needed_config_files
178.4.4. root_device
178.4.5. root_mountpoint
178.5. Module Requirements
178.5.1. Module Imports
178.5.2. Module Includes
179.
179.1. Authors
179.2. Summary of Module Globals
179.2.1.
179.2.2.
179.3. Global Functions
179.3.1. EmptyList
179.3.2. EmptyListWithParam
179.3.3. EmptyMap
179.3.4. EmptyString
179.3.5. False
179.3.6. GetGroupMap
179.3.7. GlobalProvides
179.3.8. IsSubSet
179.3.9. ProvideBoolean
179.3.10. ProvideList
179.3.11. ProvideMap
179.3.12. ProvidePath
179.3.13. ProvideString
179.3.14. RequireBoolean
179.3.15. RequireList
179.3.16. RequireMap
179.3.17. RequirePath
179.3.18. RequireString
179.3.19. Reset
179.3.20. SetGlobalProvides
179.3.21. SymbolError
179.4. Global Variables
179.4.1. current_detect_map
179.4.2. current_direct_name
179.4.3. current_module_name
179.4.4. detect_group_list
179.4.5. global_entries
179.4.6. tool_name
179.5. Module Requirements
180. OSRDirect
180.1. Authors
180.2. Summary of Module Globals
180.2.1.
180.2.2.
180.3. Global Functions
180.3.1. AddEntries
180.3.2. EvalDirectMethod
180.3.3. OptionMenu
180.3.4. Reset
180.4. Global Variables
180.4.1. mounted_root_partition
180.5. Module Requirements
180.5.1. Module Imports
180.5.2. Module Includes
181. OSRExecute
181.1. Authors
181.2. Summary of Module Globals
181.2.1.
181.2.2.
181.3. Global Functions
181.3.1. Command
181.3.2. CommandOutput
181.3.3. CommandProgress
181.4. Global Variables
181.5. Module Requirements
181.5.1. Module Imports
181.5.2. Module Includes
182. OSRFloppy
182.1. Authors
182.2. Summary of Module Globals
182.2.1.
182.2.2.
182.3. Global Functions
182.3.1. Close
182.3.2. NextStep
182.3.3. Open
182.4. Global Variables
182.4.1. floppy_device
182.4.2. mount_point
182.5. Module Requirements
182.5.1. Module Imports
182.5.2. Module Includes
183. OSRFsck
183.1. Authors
183.2. Summary of Module Globals
183.2.1.
183.2.2.
183.3. Global Functions
183.3.1. Check
183.3.2. IsNonLinuxFileSystem
183.3.3. LoadAllFsModules
183.3.4. OSRFsck
183.3.5. PossiblePartitions
183.3.6. Repair
183.4. Global Variables
183.4.1. fs_kernel_modules
183.4.2. fsck_fsid
183.4.3. fsck_type
183.4.4. not_installed_modules
183.5. Module Requirements
183.5.1. Module Imports
183.5.2. Module Includes
184. OSRFstab
184.1. Authors
184.2. Summary of Module Globals
184.2.1.
184.2.2.
184.3. Global Functions
184.3.1. BootDev
184.3.2. Check
184.3.3. CheckRootEntry
184.3.4. LinuxPartitions
184.3.5. MountAll
184.3.6. MountablePartitions
184.3.7. OSRFstab
184.3.8. ReadFstab
184.3.9. ReadSuccessfully
184.3.10. Repair
184.3.11. RootDev
184.3.12. SelectRoot
184.3.13. UmountAll
184.3.14. UmountAllFrom
184.3.15. ValidRootPartitions
184.3.16. check_and_create_mount_points
184.3.17. partition_mounted
184.4. Global Variables
184.4.1. fstabpath
184.5. Module Requirements
184.5.1. Module Imports
184.5.2. Module Includes
185. OSRLogFile
185.1. Authors
185.2. Summary of Module Globals
185.2.1.
185.2.2.
185.3. Global Functions
185.3.1. Add
185.3.2. GetLogFileName
185.3.3. GetTmpDir
185.3.4. OSRLogFile
185.4. Global Variables
185.5. Module Requirements
186. OSRMode
186.1. Authors
186.2. Summary of Module Globals
186.2.1.
186.2.2.
186.3. Global Functions
186.3.1. IsValid
186.4. Global Variables
186.4.1. automatic
186.4.2. demo
186.4.3. detection
186.4.4. provides
186.4.5. script
186.5. Module Requirements
186.5.1. Module Imports
186.5.2. Module Includes
187. OSRModuleLoading
187.1. Authors
187.2. Summary of Module Globals
187.2.1.
187.2.2.
187.3. Global Functions
187.3.1. Load
187.3.2. OSRModuleLoading
187.3.3. Unload
187.3.4. UnloadAll
187.4. Global Variables
187.5. Module Requirements
187.5.1. Module Imports
187.5.2. Module Includes
188. OSRPkg
188.1. Authors
188.2. Summary of Module Globals
188.2.1.
188.2.2.
188.3. Global Functions
188.3.1. CheckDB
188.3.2. CheckMinimum
188.3.3. CheckProductVersions
188.3.4. InstallMissing
188.3.5. OSRPkg
188.3.6. OpenPkg
188.3.7. RepairDB
188.3.8. Reset
188.3.9. VerifyPackages
188.4. Global Variables
188.4.1. error_text
188.4.2. help_text
188.4.3. install_missing_dialog_data
188.4.4. missing_packages
188.4.5. not_found_files
188.4.6. root_mountpoint
188.5. Module Requirements
188.5.1. Module Imports
188.5.2. Module Includes
189. OSRPkgUI
189.1. Authors
189.2. Summary of Module Globals
189.2.1.
189.2.2.
189.3. Global Functions
189.3.1. EvalUserInput
189.3.2. Finish
189.3.3. OSRPkgUI
189.3.4. OpenVerifyDialog
189.3.5. ProtocolDialog
189.3.6. Reset
189.3.7. update_missing_packages
189.4. Global Variables
189.4.1. expert_mode
189.5. Module Requirements
189.5.1. Module Imports
189.5.2. Module Includes
190. OSRPkgVerify
190.1. Authors
190.2. Summary of Module Globals
190.2.1.
190.2.2.
190.3. Global Functions
190.3.1. GreenPackageProblems
190.3.2. OSRPkgVerify
190.3.3. Reset
190.3.4. Verify
190.3.5. WriteVerifiedPackages
190.4. Global Variables
190.4.1. initial_verified_packages
190.4.2. max_files
190.4.3. missing
190.4.4. separator
190.4.5. unsatisfied
190.5. Module Requirements
190.5.1. Module Imports
190.5.2. Module Includes
191. OSRPopup
191.1. Authors
191.2. Summary of Module Globals
191.2.1.
191.2.2.
191.3. Global Functions
191.3.1. ChangeFieldDialog
191.3.2. MultiSelectionBox
191.3.3. OpenMainRepairDialog
191.3.4. OpenSuggestDialog
191.3.5. RadioButtonGroup
191.3.6. RadioButtonGroupText
191.3.7. Repair
191.3.8. build_label_description
191.4. Global Variables
191.5. Module Requirements
191.5.1. Module Imports
191.5.2. Module Includes
192. OSRProgress
192.1. Authors
192.2. Summary of Module Globals
192.2.1.
192.2.2.
192.3. Global Functions
192.3.1. Create
192.3.2. DeleteFile
192.3.3. Fill
192.3.4. Increase
192.3.5. Reset
192.3.6. SetFile
192.3.7. SetLabel
192.3.8. SetLength
192.3.9. SetSteps
192.4. Global Variables
192.4.1. length
192.5. Module Requirements
192.5.1. Module Imports
192.5.2. Module Includes
193. OSRPtbl
193.1. Authors
193.2. Summary of Module Globals
193.2.1.
193.2.2.
193.3. Global Functions
193.3.1. MainPtblRepairDialog
193.3.2. RestoreWithGpart
193.3.3. WritePartitionsInfo2Floppy
193.4. Global Variables
193.5. Module Requirements
193.5.1. Module Imports
193.5.2. Module Includes
194. OSRRepairUI
194.1. Authors
194.2. Summary of Module Globals
194.2.1.
194.2.2.
194.3. Global Functions
194.3.1. InitDialog
194.3.2. OSRRepairUI
194.3.3. OsrMainDialog
194.3.4. Reset
194.4. Global Variables
194.5. Module Requirements
194.5.1. Module Imports
194.5.2. Module Includes
195. OSRStatus
195.1. Authors
195.2. Summary of Module Globals
195.2.1.
195.2.2.
195.3. Global Functions
195.3.1. DetectError
195.3.2. DetectError2Name
195.3.3. DetectOK
195.3.4. DetectOK2Name
195.3.5. DetectOmit
195.3.6. DetectProblem
195.3.7. DetectProblem2Name
195.3.8. ErrorSeverityBlocking
195.3.9. ErrorSeverityModuleBlocking
195.3.10. Exit
195.3.11. IsErrorSeverityBlocking
195.3.12. IsErrorSeverityModuleBlocking
195.3.13. IsStatusDetectError
195.3.14. IsStatusDetectOK
195.3.15. IsStatusDetectOmit
195.3.16. IsStatusDetectProblem
195.3.17. IsStatusExit
195.3.18. IsStatusRepairError
195.3.19. IsStatusRepairOK
195.3.20. IsStatusRepairOmit
195.3.21. NotFound2Name
195.3.22. RepairError
195.3.23. RepairError2Name
195.3.24. RepairOK
195.3.25. RepairOK2Name
195.3.26. RepairOmit
195.3.27. RepairOmit2Name
195.4. Global Variables
195.5. Module Requirements
196. OSRSummary
196.1. Authors
196.2. Summary of Module Globals
196.2.1.
196.2.2.
196.3. Global Functions
196.3.1. DetectError
196.3.2. DetectOK
196.3.3. DetectOmit
196.3.4. DetectProblem
196.3.5. RepairError
196.3.6. RepairOK
196.3.7. RepairOmit
196.3.8. Update
196.4. Global Variables
196.5. Module Requirements
196.5.1. Module Imports
196.5.2. Module Includes
197. OSRSwap
197.1. Authors
197.2. Summary of Module Globals
197.2.1.
197.2.2.
197.3. Global Functions
197.3.1. Partitions
197.3.2. Repair
197.3.3. ValidPartitions
197.4. Global Variables
197.5. Module Requirements
197.5.1. Module Imports
197.5.2. Module Includes
198. OSRSystem
198.1. Authors
198.2. Summary of Module Globals
198.2.1.
198.2.2.
198.3. Global Functions
198.3.1. ChangeRoot
198.3.2. SetTargetRoot
198.4. Global Variables
198.5. Module Requirements
198.5.1. Module Imports
198.5.2. Module Includes
199. OneClickInstall
199.1. Authors
199.2. Summary of Module Globals
199.2.1.
199.2.2.
199.3. Global Functions
199.3.1. FromXML
199.3.2. GetDescription
199.3.3. GetName
199.3.4. GetNonRequiredRemoveSoftware
199.3.5. GetNonRequiredRepositories
199.3.6. GetNonRequiredSoftware
199.3.7. GetRemainSubscribed
199.3.8. GetRepositoryDescription
199.3.9. GetRepositoryName
199.3.10. GetRepositorySummary
199.3.11. GetRequiredRemoveSoftware
199.3.12. GetRequiredRepositories
199.3.13. GetRequiredSoftware
199.3.14. GetSoftwareDescription
199.3.15. GetSoftwareSummary
199.3.16. GetSummary
199.3.17. HaveAnyRecommended
199.3.18. HaveAnythingToDo
199.3.19. HaveBundleDescription
199.3.20. HaveRemovals
199.3.21. HaveRepositories
199.3.22. HaveSoftware
199.3.23. Load
199.3.24. SetNonRequiredRepository
199.3.25. SetNonRequiredSoftware
199.3.26. SetRemainSubscribed
199.3.27. SetRequiredRepositories
199.3.28. SetRequiredRepository
199.3.29. SetRequiredSoftware
199.3.30. SetRequiredSoftwares
199.3.31. ToXML
199.4. Global Variables
199.5. Module Requirements
199.5.1. Module Imports
199.5.2. Module Includes
200. OneClickInstallStandard
200.1. Authors
200.2. Summary of Module Globals
200.2.1.
200.2.2.
200.3. Global Functions
200.3.1. GetRepositoriesFromXML
200.4. Global Variables
200.5. Module Requirements
200.5.1. Module Imports
200.5.2. Module Includes
201.
201.1. Authors
201.2. Summary of Module Globals
201.2.1.
201.2.2.
201.3. Global Functions
201.4. Global Variables
201.5. Module Requirements
201.5.1. Module Imports
201.5.2. Module Includes
202. OneClickInstallWorkerFunctions
202.1. Authors
202.2. Summary of Module Globals
202.2.1.
202.2.2.
202.3. Global Functions
202.3.1. AddRepositories
202.3.2. DeDupe
202.3.3. InstallPackages
202.3.4. InstallPatterns
202.3.5. RemovePackages
202.4. Global Variables
202.5. Module Requirements
202.5.1. Module Imports
202.5.2. Module Includes
203. OneClickInstallWorkerResponse
203.1. Authors
203.2. Summary of Module Globals
203.2.1.
203.2.2.
203.3. Global Functions
203.3.1. FromXML
203.3.2. GetErrorMessage
203.3.3. GetFailureStage
203.3.4. GetNote
203.3.5. GetSuccess
203.3.6. SetErrorMessage
203.3.7. SetFailureStage
203.3.8. SetNote
203.3.9. SetSuccess
203.3.10. ToXML
203.4. Global Variables
203.5. Module Requirements
203.5.1. Module Imports
203.5.2. Module Includes
204. OnlineUpdate
204.1. Authors
204.2. Summary of Module Globals
204.2.1.
204.2.2.
204.3. Global Functions
204.4. Global Variables
204.4.1. cd_directory
204.4.2. cd_update
204.4.3. cd_url
204.4.4. simple_mode
204.5. Module Requirements
205. OnlineUpdateCallbacks
205.1. Authors
205.2. Summary of Module Globals
205.2.1.
205.2.2.
205.3. Global Functions
205.3.1. DonePackage
205.3.2. DoneProvide
205.3.3. FinishLine
205.3.4. PatchProgressCallback
205.3.5. ProblemDeltaApply
205.3.6. ProblemDeltaDownload
205.3.7. ProblemPatchDownload
205.3.8. ProgressDeltaApply
205.3.9. ProgressDeltaDownload
205.3.10. ProgressLog
205.3.11. ProgressPatchDownload
205.3.12. RefreshSources
205.3.13. RegisterOnlineUpdateCallbacks
205.3.14. StartDeltaDownload
205.3.15. StartPackage
205.3.16. StartPatchDownload
205.3.17. StartProvide
205.4. Global Variables
205.5. Module Requirements
205.5.1. Module Imports
205.5.2. Module Includes
206. OnlineUpdateConfiguration
206.1. Authors
206.2. Summary of Module Globals
206.2.1.
206.2.2.
206.3. Global Functions
206.3.1. Export
206.4. Global Variables
206.5. Module Requirements
206.5.1. Module Imports
206.5.2. Module Includes
207. OnlineUpdateDialogs
207.1. Authors
207.2. Summary of Module Globals
207.2.1.
207.2.2.
207.3. Global Functions
207.4. Global Variables
207.5. Module Requirements
207.5.1. Module Imports
207.5.2. Module Includes
208. Package
208.1. Authors
208.2. Summary of Module Globals
208.2.1.
208.2.2.
208.3. Global Functions
208.3.1. DoInstall
208.3.2. DoInstallAndRemove
208.3.3. DoRemove
208.4. Global Variables
208.5. Module Requirements
208.5.1. Module Imports
208.5.2. Module Includes
209. PackageAI
209.1. Authors
209.2. Summary of Module Globals
209.2.1.
209.2.2.
209.3. Global Functions
209.3.1. GetModified
209.3.2. PackageAvailable
209.3.3. PackageInstalled
209.3.4. SetModified
209.4. Global Variables
209.5. Module Requirements
209.5.1. Module Imports
209.5.2. Module Includes
210. PackageCallbacks
210.1. Authors
210.2. Summary of Module Globals
210.2.1.
210.2.2.
210.3. Global Functions
210.3.1. DonePackage
210.3.2. DoneScanDb
210.3.3. EnableAsterixPackage
210.3.4. ErrorScanDb
210.3.5. InitPackageCallbacks
210.3.6. PackageCallbacks
210.3.7. ProcessDone
210.3.8. ProcessNextStage
210.3.9. ProcessProgress
210.3.10. ProcessStart
210.3.11. ProgressPackage
210.3.12. ProgressScanDb
210.3.13. SetMediaCallbacks
210.3.14. SourceChange
210.3.15. StartPackage
210.3.16. StartScanDb
210.4. Global Variables
210.5. Module Requirements
210.5.1. Module Imports
210.5.2. Module Includes
211. PackageCallbacksInit
211.1. Authors
211.2. Summary of Module Globals
211.2.1.
211.2.2.
211.3. Global Functions
211.3.1. InitPackageCallbacks
211.4. Global Variables
211.5. Module Requirements
211.5.1. Module Imports
211.5.2. Module Includes
212. PackageInstallation
212.1. Authors
212.2. Summary of Module Globals
212.2.1.
212.2.2.
212.3. Global Functions
212.3.1. CommitPackages
212.4. Global Variables
212.5. Module Requirements
212.5.1. Module Imports
212.5.2. Module Includes
213. PackageLock
213.1. Authors
213.2. Summary of Module Globals
213.2.1.
213.2.2.
213.3. Global Functions
213.3.1. Check
213.3.2. Connect
213.4. Global Variables
213.5. Module Requirements
213.5.1. Module Imports
213.5.2. Module Includes
214. PackageSlideShow
214.1. Authors
214.2. Summary of Module Globals
214.2.1.
214.2.2.
214.3. Global Functions
214.3.1. InitPkgData
214.3.2. SetCurrentCdNo
214.3.3. SetMediaType
214.3.4. SlideDisplayDone
214.3.5. SlideDisplayStart
214.3.6. SlideProvideStart
214.3.7. StripPath
214.3.8. StripReleaseNo
214.3.9. UpdateAllCdProgress
214.3.10. UpdateCurrentCdProgress
214.3.11. UpdateCurrentPackageProgress
214.4. Global Variables
214.5. Module Requirements
214.5.1. Module Imports
214.5.2. Module Includes
215. PackageSystem
215.1. Authors
215.2. Summary of Module Globals
215.2.1.
215.2.2.
215.3. Global Functions
215.3.1. Available
215.3.2. CheckAndInstallPackages
215.3.3. CheckAndInstallPackagesInteractive
215.3.4. EnsureSourceInit
215.3.5. EnsureTargetInit
215.3.6. Installed
215.3.7. PackageAvailable
215.3.8. PackageInstalled
215.4. Global Variables
215.5. Module Requirements
215.5.1. Module Imports
215.5.2. Module Includes
216. Packages
216.1. Authors
216.2. Summary of Module Globals
216.2.1.
216.2.2.
216.3. Global Functions
216.3.1. CheckContentFile
216.3.2. CheckDiskSize
216.3.3. CheckOldAddOns
216.3.4. ComputeSystemPackageList
216.3.5. CountSizeToBeDownloaded
216.3.6. CountSizeToBeInstalled
216.3.7. GetBaseSourceID
216.3.8. InfoAboutSubOptimalDistribution
216.3.9. Initialize
216.3.10. InitializeAddOnProducts
216.3.11. InitializeCatalogs
216.3.12. ListSelected
216.3.13. Proposal
216.3.14. Reset
216.3.15. SelectProduct
216.3.16. Summary
216.3.17. SummaryOutput
216.3.18. addAdditionalPackage
216.4. Global Variables
216.5. Module Requirements
216.5.1. Module Imports
216.5.2. Module Includes
217. PackagesProposal
217.1. Authors
217.2. Summary of Module Globals
217.2.1.
217.2.2.
217.3. Global Functions
217.3.1. AddResolvables
217.3.2. GetAllResolvables
217.3.3. GetAllResolvablesForAllTypes
217.3.4. GetResolvables
217.3.5. GetSupportedResolvables
217.3.6. IsUniqueID
217.3.7. RemoveResolvables
217.3.8. ResetAll
217.3.9. SetResolvables
217.4. Global Variables
217.5. Module Requirements
218. PackagesUI
218.1. Authors
218.2. Summary of Module Globals
218.2.1.
218.2.2.
218.3. Global Functions
218.3.1. ConfirmLicenses
218.3.2. RunPackageSelector
218.3.3. RunPatternSelector
218.4. Global Variables
218.5. Module Requirements
218.5.1. Module Imports
218.5.2. Module Includes
219. Pam
219.1. Authors
219.2. Summary of Module Globals
219.2.1.
219.2.2.
219.3. Global Functions
219.3.1. Add
219.3.2. Enabled
219.3.3. Query
219.3.4. Remove
219.3.5. Set
219.4. Global Variables
219.5. Module Requirements
220. PamSettings
220.1. Authors
220.2. Summary of Module Globals
220.2.1.
220.2.2.
220.3. Global Functions
220.3.1. AddValue
220.3.2. GetDefaultValue
220.3.3. GetFile
220.3.4. GetFiles
220.3.5. GetGroupHashMethod
220.3.6. GetHashMethod
220.3.7. GetValues
220.3.8. RemoveValue
220.3.9. SetDefaultValue
220.3.10. SetGroupHashMethod
220.3.11. SetHashMethod
220.3.12. SetValues
220.3.13. Write
220.4. Global Variables
220.5. Module Requirements
220.5.1. Module Imports
220.5.2. Module Includes
221. Partitions
221.1. Authors
221.2. Summary of Module Globals
221.2.1.
221.2.2.
221.3. Global Functions
221.3.1. CurMounted
221.4. Global Variables
221.5. Module Requirements
221.5.1. Module Imports
221.5.2. Module Includes
222. Popup
222.1. Authors
222.2. Summary of Module Globals
222.2.1.
222.2.2.
222.3. Global Functions
222.3.1. AnyMessage
222.3.2. AnyQuestion
222.3.3. AnyQuestion3
222.3.4. AnyQuestionRichText
222.3.5. AnyTimedMessage
222.3.6. ClearFeedback
222.3.7. ConfirmAbort
222.3.8. ContinueCancel
222.3.9. ContinueCancelHeadline
222.3.10. Error
222.3.11. ErrorDetails
222.3.12. LongError
222.3.13. LongErrorGeometry
222.3.14. LongMessage
222.3.15. LongMessageGeometry
222.3.16. LongNotify
222.3.17. LongNotifyGeometry
222.3.18. LongText
222.3.19. LongWarning
222.3.20. LongWarningGeometry
222.3.21. Message
222.3.22. MessageDetails
222.3.23. ModuleError
222.3.24. NoHeadline
222.3.25. NoIcon
222.3.26. Notify
222.3.27. NotifyDetails
222.3.28. ReallyAbort
222.3.29. ShowFeedback
222.3.30. ShowFile
222.3.31. ShowText
222.3.32. ShowTextTimed
222.3.33. TimedAnyQuestion
222.3.34. TimedError
222.3.35. TimedLongError
222.3.36. TimedLongErrorGeometry
222.3.37. TimedLongMessage
222.3.38. TimedLongMessageGeometry
222.3.39. TimedLongNotify
222.3.40. TimedLongNotifyGeometry
222.3.41. TimedLongWarning
222.3.42. TimedLongWarningGeometry
222.3.43. TimedMessage
222.3.44. TimedNotify
222.3.45. TimedOKCancel
222.3.46. TimedWarning
222.3.47. Warning
222.3.48. WarningDetails
222.3.49. YesNo
222.3.50. YesNoHeadline
222.4. Global Variables
222.5. Module Requirements
222.5.1. Module Imports
222.5.2. Module Includes
223. PortAliases
223.1. Authors
223.2. Summary of Module Globals
223.2.1.
223.2.2.
223.3. Global Functions
223.3.1. AllowedPortNameOrNumber
223.3.2. GetListOfServiceAliases
223.3.3. GetPortNumber
223.3.4. IsAllowedPortName
223.3.5. IsKnownPortName
223.4. Global Variables
223.5. Module Requirements
223.5.1. Module Imports
223.5.2. Module Includes
224. PortRanges
224.1. Authors
224.2. Summary of Module Globals
224.2.1.
224.2.2.
224.3. Global Functions
224.3.1. CreateNewPortRange
224.3.2. DividePortsAndPortRanges
224.3.3. FlattenServices
224.3.4. IsPortRange
224.3.5. IsValidPortRange
224.3.6. PortIsInPortranges
224.3.7. RemovePortFromPortRanges
224.4. Global Variables
224.4.1. max_port_number
224.5. Module Requirements
224.5.1. Module Imports
224.5.2. Module Includes
225. PowerManagement
225.1. Authors
225.2. Summary of Module Globals
225.2.1.
225.2.2.
225.3. Global Functions
225.3.1. Abort
225.3.2. AutoPackages
225.3.3. Export
225.3.4. FetchScheme
225.3.5. FetchSchemes
225.3.6. FindScheme
225.3.7. Import
225.3.8. Modified
225.3.9. Modified
225.3.10. Read
225.3.11. StoreScheme
225.3.12. StoreSchemes
225.3.13. Summary
225.3.14. TranslatePowersaveText
225.3.15. TranslateSchemeDescription
225.3.16. TranslateSchemeName
225.3.17. Write
225.4. Global Variables
225.4.1. modified
225.4.2. proposal_valid
225.4.3. write_only
225.5. Module Requirements
225.5.1. Module Imports
225.5.2. Module Includes
226. Printer
226.1. Authors
226.2. Summary of Module Globals
226.2.1.
226.2.2.
226.3. Global Functions
226.3.1. Abort
226.3.2. AddQueue
226.3.3. AutoPackages
226.3.4. AutodetectQueues
226.3.5. ConnectionItems
226.3.6. DeleteQueue
226.3.7. DetermineDriverOptions
226.3.8. DriverItems
226.3.9. DriverOptionItems
226.3.10. Export
226.3.11. FirewallConfig
226.3.12. Import
226.3.13. Modified
226.3.14. Modified
226.3.15. NewQueueName
226.3.16. QueueItems
226.3.17. Read
226.3.18. Write
226.4. Global Variables
226.4.1. connections
226.4.2. driver_options
226.4.3. firewall_config
226.4.4. modified
226.4.5. number_chars
226.4.6. ppds
226.4.7. proposal_valid
226.4.8. queue_filter_show_local
226.4.9. queues
226.4.10. selected_connections_index
226.4.11. selected_ppds_index
226.4.12. selected_queues_index
226.4.13. write_only
226.5. Module Requirements
226.5.1. Module Imports
226.5.2. Module Includes
227. Printerlib
227.1. Authors
227.2. Summary of Module Globals
227.2.1.
227.2.2.
227.3. Global Functions
227.3.1. ExecuteBashCommand
227.3.2. TestAndInstallPackage
227.4. Global Variables
227.5. Module Requirements
227.5.1. Module Imports
227.5.2. Module Includes
228. Product
228.1. Authors
228.2. Summary of Module Globals
228.2.1.
228.2.2.
228.3. Global Functions
228.3.1. Product
228.3.2. ReadProducts
228.4. Global Variables
228.4.1. baseproduct
228.4.2. dist
228.4.3. flags
228.4.4. name
228.4.5. patterns
228.4.6. product_of_relnotes
228.4.7. relnotesurl
228.4.8. relnotesurl_all
228.4.9. run_you
228.4.10. shortlabel
228.5. Module Requirements
228.5.1. Module Imports
228.5.2. Module Includes
229. ProductControl
229.1. Authors
229.2. Summary of Module Globals
229.2.1.
229.2.2.
229.3. Global Functions
229.3.1. AddWizardSteps
229.3.2. DisableModule
229.3.3. DisableProposal
229.3.4. EnableModule
229.3.5. EnableProposal
229.3.6. GetDisabledModules
229.3.7. GetDisabledProposals
229.3.8. GetUseAutomaticConfiguration
229.3.9. Init
229.3.10. InitAutomaticConfiguration
229.3.11. ProductControl
229.3.12. ReadControlFile
229.3.13. RequiredFiles
229.3.14. ResetAdditionalWorkflowParams
229.3.15. RestartingStep
229.3.16. RetranslateWizardSteps
229.3.17. Run
229.3.18. RunRequired
229.3.19. SetAdditionalWorkflowParams
229.3.20. SetUseAutomaticConfiguration
229.3.21. SkippedSteps
229.3.22. UpdateWizardSteps
229.3.23. checkArch
229.3.24. checkDisabled
229.3.25. getClientTerm
229.3.26. getCompleteWorkflow
229.3.27. getLockedProposals
229.3.28. getModeDefaults
229.3.29. getModules
229.3.30. getProposalProperties
229.3.31. getProposalTextDomain
229.3.32. getProposals
229.3.33. getWorkflowLabel
229.3.34. setClientPrefix
229.4. Global Variables
229.5. Module Requirements
229.5.1. Module Imports
229.5.2. Module Includes
230. ProductCreator
230.1. Authors
230.2. Summary of Module Globals
230.2.1.
230.2.2.
230.3. Global Functions
230.3.1. Abort
230.3.2. CheckLanguage
230.3.3. CopyMiscFiles
230.3.4. CopyPackages
230.3.5. CreateSkeleton
230.3.6. EnableSource
230.3.7. Export
230.3.8. GetDirSources
230.3.9. Import
230.3.10. Modified
230.3.11. Overview
230.3.12. PollAbort
230.3.13. PrepareConfigs
230.3.14. ProductCreator
230.3.15. Read
230.3.16. Readisolinux
230.3.17. ReallyAbort
230.3.18. SetPackageArch
230.3.19. Summary
230.3.20. Write
230.3.21. WritePatternFile
230.3.22. checkPackageAvail
230.3.23. checkProductDependency
230.3.24. configSetup
230.3.25. getSourceDir
230.3.26. getSourceURLs
230.3.27. setPackages
230.4. Global Variables
230.4.1. AbortFunction
230.4.2. modified
230.5. Module Requirements
230.5.1. Module Imports
230.5.2. Module Includes
231. ProductFeatures
231.1. Authors
231.2. Summary of Module Globals
231.2.1.
231.2.2.
231.3. Global Functions
231.3.1. Export
231.3.2. GetBooleanFeature
231.3.3. GetFeature
231.3.4. GetSection
231.3.5. GetStringFeature
231.3.6. Import
231.3.7. InitIfNeeded
231.3.8. Restore
231.3.9. Save
231.3.10. SetBooleanFeature
231.3.11. SetFeature
231.3.12. SetSection
231.3.13. SetStringFeature
231.4. Global Variables
231.5. Module Requirements
231.5.1. Module Imports
231.5.2. Module Includes
232. ProductLicense
232.1. Authors
232.2. Summary of Module Globals
232.2.1.
232.2.2.
232.3. Global Functions
232.3.1. AcceptanceNeeded
232.3.2. AskLicenseAgreement
232.3.3. ShowFullScreenLicenseInInstallation
232.3.4. ShowLicenseInInstallation
232.4. Global Variables
232.5. Module Requirements
232.5.1. Module Imports
232.5.2. Module Includes
233. Profile
233.1. Authors
233.2. Summary of Module Globals
233.2.1.
233.2.2.
233.3. Global Functions
233.3.1. Import
233.3.2. Prepare
233.3.3. Profile
233.3.4. ReadProfileStructure
233.3.5. ReadProperties
233.3.6. ReadXML
233.3.7. Reset
233.3.8. Save
233.3.9. SaveProfileStructure
233.3.10. SaveSingleSections
233.3.11. convertLVM
233.3.12. convertRAID
233.3.13. generalCompat
233.3.14. setElementByList
233.4. Global Variables
233.5. Module Requirements
233.5.1. Module Imports
233.5.2. Module Includes
234. ProfileLocation
234.1. Authors
234.2. Summary of Module Globals
234.2.1.
234.2.2.
234.3. Global Functions
234.3.1. Process
234.3.2. ProfileLocation
234.4. Global Variables
234.5. Module Requirements
234.5.1. Module Imports
234.5.2. Module Includes
235. ProfileManager
235.1. Authors
235.2. Summary of Module Globals
235.2.1.
235.2.2.
235.3. Global Functions
235.3.1. CheckNameValidity
235.3.2. GetDefaultResourceGroups
235.3.3. GetHashMarks
235.3.4. GetProgressText
235.3.5. GetResourceGroupResources
235.3.6. GetResourceGroups
235.3.7. GetUsernames
235.3.8. GetUsers
235.3.9. GetUsersAllowed
235.3.10. Modified
235.3.11. ProgressPopup
235.3.12. Read
235.3.13. ReadConfigFile
235.3.14. ReadResourceGroups
235.3.15. ReadUsers
235.3.16. RebuildDB
235.3.17. Recover
235.3.18. ResetResourceGroup
235.3.19. ResetResourceGroups
235.3.20. Rollback
235.3.21. SaveResourceGroups
235.3.22. SetUsers
235.3.23. Wait
235.3.24. Write
235.3.25. WriteConfigFile
235.3.26. WriteResourceGroups
235.3.27. WriteSCPMStatus
235.3.28. WriteStatus
235.3.29. WriteStatusFirst
235.3.30. WriteUsers
235.3.31. WriteUsersAllowed
235.4. Global Variables
235.4.1. conf_modified
235.4.2. enabled
235.4.3. hash_size
235.4.4. initialized
235.4.5. needs_recover
235.4.6. needs_reinit
235.4.7. resource_groups
235.4.8. resource_groups_deleted
235.4.9. resource_groups_modified
235.4.10. scpm_conf
235.4.11. scpm_error
235.4.12. status_modified
235.4.13. users_allowed
235.4.14. users_modified
235.5. Module Requirements
235.5.1. Module Imports
235.5.2. Module Includes
236. Progress
236.1. Authors
236.2. Summary of Module Globals
236.2.1.
236.2.2.
236.3. Global Functions
236.3.1. CloseSuperior
236.3.2. CurrentSubprogressType
236.3.3. Finish
236.3.4. New
236.3.5. NewProgressIcons
236.3.6. NextStage
236.3.7. NextStageStep
236.3.8. NextStep
236.3.9. OpenSuperior
236.3.10. Simple
236.3.11. Stage
236.3.12. Step
236.3.13. StepSuperior
236.3.14. SubprogressTitle
236.3.15. SubprogressType
236.3.16. SubprogressValue
236.3.17. Title
236.3.18. off
236.3.19. on
236.3.20. set
236.3.21. status
236.4. Global Variables
236.5. Module Requirements
236.5.1. Module Imports
236.5.2. Module Includes
237. Provider
237.1. Authors
237.2. Summary of Module Globals
237.2.1.
237.2.2.
237.3. Global Functions
237.3.1. Add
237.3.2. Clone
237.3.3. CloneSystem
237.3.4. Commit
237.3.5. Delete
237.3.6. Edit
237.3.7. Export
237.3.8. GetCountries
237.3.9. GetCountry
237.3.10. GetProviders
237.3.11. Import
237.3.12. IsUnique
237.3.13. Modified
237.3.14. Overview
237.3.15. ProviderType
237.3.16. Read
237.3.17. Select
237.3.18. SelectSystem
237.3.19. Summary
237.3.20. Write
237.4. Global Variables
237.4.1. Current
237.4.2. LastCountry
237.4.3. Name
237.4.4. Type
237.5. Module Requirements
237.5.1. Module Imports
237.5.2. Module Includes
238. Proxy
238.1. Authors
238.2. Summary of Module Globals
238.2.1.
238.2.2.
238.3. Global Functions
238.3.1. Export
238.3.2. GetEnvironment
238.3.3. GetModified
238.3.4. Import
238.3.5. RunTestProxy
238.3.6. SetModified
238.3.7. Summary
238.3.8. Write
238.4. Global Variables
238.4.1. modified
238.5. Module Requirements
238.5.1. Module Imports
238.5.2. Module Includes
239. PulseAudio
239.1. Authors
239.2. Summary of Module Globals
239.2.1.
239.2.2.
239.3. Global Functions
239.4. Global Variables
239.5. Module Requirements
239.5.1. Module Imports
239.5.2. Module Includes
240. Punycode
240.1. Authors
240.2. Summary of Module Globals
240.2.1.
240.2.2.
240.3. Global Functions
240.3.1. DecodeDomainName
240.3.2. DecodePunycodes
240.3.3. DocodeDomainNames
240.3.4. EncodeDomainName
240.3.5. EncodePunycodes
240.3.6. GetMaximumCacheSize
240.3.7. SetMaximumCacheSize
240.4. Global Variables
240.5. Module Requirements
241. Region
241.1. Authors
241.2. Summary of Module Globals
241.2.1.
241.2.2.
241.3. Global Functions
241.3.1. Inside
241.4. Global Variables
241.5. Module Requirements
242. Register
242.1. Authors
242.2. Summary of Module Globals
242.2.1.
242.2.2.
242.3. Global Functions
242.3.1. Export
242.4. Global Variables
242.5. Module Requirements
242.5.1. Module Imports
242.5.2. Module Includes
243. Reipl
243.1. Authors
243.2. Summary of Module Globals
243.2.1.
243.2.2.
243.3. Global Functions
243.3.1. Abort
243.3.2. AutoPackages
243.3.3. Export
243.3.4. FindBootPartition
243.3.5. FindSysfsRoot
243.3.6. Import
243.3.7. Modified
243.3.8. Modified
243.3.9. ModifyReiplWithBootPartition
243.3.10. Read
243.3.11. ReadState
243.3.12. SanityCheck
243.3.13. SetModified
243.3.14. Summary
243.3.15. Write
243.3.16. WriteState
243.4. Global Variables
243.4.1. modified
243.4.2. proposal_valid
243.4.3. write_only
243.5. Module Requirements
243.5.1. Module Imports
243.5.2. Module Includes
244. Remote
244.1. Authors
244.2. Summary of Module Globals
244.2.1.
244.2.2.
244.3. Global Functions
244.3.1. Propose
244.3.2. Read
244.3.3. Reset
244.3.4. Summary
244.3.5. Write
244.4. Global Variables
244.4.1. allow_administration
244.4.2. default_dm
244.5. Module Requirements
244.5.1. Module Imports
244.5.2. Module Includes
245. Report
245.1. Authors
245.2. Summary of Module Globals
245.2.1.
245.2.2.
245.3. Global Functions
245.3.1. AnyQuestion
245.3.2. ClearAll
245.3.3. ClearErrors
245.3.4. ClearMessages
245.3.5. ClearWarnings
245.3.6. ClearYesNoMessages
245.3.7. DisplayErrors
245.3.8. DisplayMessages
245.3.9. DisplayWarnings
245.3.10. DisplayYesNoMessages
245.3.11. Error
245.3.12. Export
245.3.13. GetMessages
245.3.14. GetModified
245.3.15. Import
245.3.16. LogErrors
245.3.17. LogMessages
245.3.18. LogWarnings
245.3.19. LogYesNoMessages
245.3.20. LongError
245.3.21. LongMessage
245.3.22. LongWarning
245.3.23. Message
245.3.24. NumErrors
245.3.25. NumMessages
245.3.26. NumWarnings
245.3.27. NumYesNoMessages
245.3.28. SetModified
245.3.29. ShowText
245.3.30. Summary
245.3.31. Warning
245.4. Global Variables
245.5. Module Requirements
245.5.1. Module Imports
245.5.2. Module Includes
246. Restore
246.1. Authors
246.2. Summary of Module Globals
246.2.1.
246.2.2.
246.3. Global Functions
246.3.1. ActivateBootloader
246.3.2. ClearInstalledPackagesCache
246.3.3. Export
246.3.4. GetActualInstalledPackages
246.3.5. GetArchiveComment
246.3.6. GetArchiveDate
246.3.7. GetArchiveFiles
246.3.8. GetArchiveHostname
246.3.9. GetArchiveInfo
246.3.10. GetArchiveInstalledPackages
246.3.11. GetArchiveName
246.3.12. GetExtraPackages
246.3.13. GetInputName
246.3.14. GetMismatchedPackages
246.3.15. GetMissingPackages
246.3.16. GetSelectedPackages
246.3.17. Import
246.3.18. IsMultiVolume
246.3.19. Modified
246.3.20. MountInput
246.3.21. Read
246.3.22. ReadActualInstalledPackages
246.3.23. ReadNextVolume
246.3.24. ResetAll
246.3.25. ResetArchiveSelection
246.3.26. Set
246.3.27. SetRestoreSelection
246.3.28. SetSelectionProperty
246.3.29. Summary
246.3.30. TestAllVolumes
246.3.31. TotalFilesToRestore
246.3.32. TotalPackagesToRestore
246.3.33. Umount
246.3.34. Write
246.4. Global Variables
246.4.1. restoreRPMdb
246.4.2. runSuSEconfig
246.4.3. runbootloader
246.5. Module Requirements
246.5.1. Module Imports
246.5.2. Module Includes
247. RichText
247.1. Authors
247.2. Summary of Module Globals
247.2.1.
247.2.2.
247.3. Global Functions
247.3.1. DetectRichText
247.3.2. Rich2Plain
247.4. Global Variables
247.5. Module Requirements
247.5.1. Module Imports
247.5.2. Module Includes
248. RootPart
248.1. Authors
248.2. Summary of Module Globals
248.2.1.
248.2.2.
248.3. Global Functions
248.3.1. AnyQuestionAnyButtonsDetails
248.3.2. FindRootPartitions
248.3.3. GetInfoOfSelected
248.3.4. IncompleteInstallationDetected
248.3.5. MountPartitions
248.3.6. SetSelectedToValid
248.3.7. UnmountPartitions
248.4. Global Variables
248.5. Module Requirements
248.5.1. Module Imports
248.5.2. Module Includes
249. Routing
249.1. Authors
249.2. Summary of Module Globals
249.2.1.
249.2.2.
249.3. Global Functions
249.3.1. Export
249.3.2. GetDevices
249.3.3. GetGateway
249.3.4. Import
249.3.5. Modified
249.3.6. Read
249.3.7. ReadFromGateway
249.3.8. RemoveDefaultGw
249.3.9. SetDevices
249.3.10. Summary
249.3.11. Write
249.4. Global Variables
249.4.1. Forward
249.4.2. Routes
249.5. Module Requirements
249.5.1. Module Imports
249.5.2. Module Includes
250. Runlevel
250.1. Authors
250.2. Summary of Module Globals
250.2.1.
250.2.2.
250.3. Global Functions
250.4. Global Variables
250.5. Module Requirements
250.5.1. Module Imports
250.5.2. Module Includes
251. RunlevelEd
251.1. Authors
251.2. Summary of Module Globals
251.2.1.
251.2.2.
251.3. Global Functions
251.3.1. CheckPortmap
251.3.2. ClearServices
251.3.3. DotRequires
251.3.4. Export
251.3.5. FilterAlreadyDoneServices
251.3.6. GetModified
251.3.7. GetRunlevel4Support
251.3.8. Import
251.3.9. Init
251.3.10. ProposalSummary
251.3.11. Read
251.3.12. ServiceDependencies
251.3.13. ServiceInstall
251.3.14. ServiceRemove
251.3.15. SetModified
251.3.16. SetRunlevel4Support
251.3.17. StartContainsImplicitly
251.3.18. Summary
251.3.19. Write
251.3.20. getDefaultPicker
251.3.21. getRunlevelDescr
251.3.22. isDirty
251.3.23. isDisabled
251.4. Global Variables
251.4.1. current
251.4.2. default_runlevel
251.4.3. runlevels
251.4.4. service_list
251.4.5. services
251.4.6. x11_selected
251.5. Module Requirements
251.5.1. Module Imports
251.5.2. Module Includes
252. SLP
252.1. Authors
252.2. Summary of Module Globals
252.2.1.
252.2.2.
252.3. Global Functions
252.3.1. AttrSummary
252.3.2. DeReg
252.3.3. DeRegFile
252.3.4. FindAttrs
252.3.5. FindSrvTypes
252.3.6. FindSrvs
252.3.7. GetAttrMap
252.3.8. GetUnicastAttrMap
252.3.9. MatchType
252.3.10. Reg
252.3.11. RegFile
252.3.12. UnicastFindAttrs
252.4. Global Variables
252.5. Module Requirements
252.5.1. Module Imports
252.5.2. Module Includes
253. Samba
253.1. Authors
253.2. Summary of Module Globals
253.2.1.
253.2.2.
253.3. Global Functions
253.3.1. AdjustSharesServices
253.3.2. AutoPackages
253.3.3. Export
253.3.4. GetDHCP
253.3.5. GetGuessAccess
253.3.6. GetHostsResolution
253.3.7. GetMaxShares
253.3.8. GetModified
253.3.9. GetPAMMountVolumes
253.3.10. GetSSHSupport
253.3.11. GetWinbind
253.3.12. GetWinbindCaching
253.3.13. GetWorkgroup
253.3.14. Import
253.3.15. Read
253.3.16. ReadMkHomeDir
253.3.17. ReadPAMMount
253.3.18. ReadSSHSupport
253.3.19. ReadSharesSetting
253.3.20. SetDHCP
253.3.21. SetGuessAccess
253.3.22. SetHostsResolution
253.3.23. SetMkHomeDir
253.3.24. SetPAMMountVolumes
253.3.25. SetSSHSupport
253.3.26. SetShares
253.3.27. SetStartFAM
253.3.28. SetWinbind
253.3.29. SetWinbindCaching
253.3.30. SetWorkgroup
253.3.31. ShortSummary
253.3.32. Summary
253.3.33. UpdatedArchPackages
253.3.34. Write
253.3.35. WriteHostsResolution
253.3.36. WriteMkHomeDir
253.3.37. WritePAMMount
253.3.38. WriteSSHSupport
253.3.39. WriteShares
253.4. Global Variables
253.4.1. globals_configured
253.4.2. mkhomedir
253.4.3. modified
253.4.4. password_data
253.4.5. start_fam
253.4.6. winbind_enabled
253.4.7. write_only
253.5. Module Requirements
253.5.1. Module Imports
253.5.2. Module Includes
254. Scanner
254.1. Authors
254.2. Summary of Module Globals
254.2.1.
254.2.2.
254.3. Global Functions
254.3.1. Abort
254.3.2. ActivateBackend
254.3.3. AutoPackages
254.3.4. DeactivateBackend
254.3.5. DetermineNetworkScanningConfig
254.3.6. Export
254.3.7. Import
254.3.8. ModelItems
254.3.9. Modified
254.3.10. OverviewContents
254.3.11. Read
254.3.12. RestartDetection
254.3.13. RunHpsetup
254.3.14. SetupNetworkScanningConfig
254.3.15. TestBackend
254.3.16. Write
254.4. Global Variables
254.4.1. active_backends
254.4.2. active_scanners
254.4.3. actual_environment
254.4.4. autodetected_scanners
254.4.5. database
254.4.6. database_manufacturers
254.4.7. database_usbids
254.4.8. firewall_config
254.4.9. ignore_unknown_USB_scanners
254.4.10. modified
254.4.11. network_scanning_config
254.4.12. number_chars
254.4.13. proposal_valid
254.4.14. selected_autodetected_scanners_index
254.4.15. selected_model_database_index
254.4.16. write_only
254.5. Module Requirements
254.5.1. Module Imports
254.5.2. Module Includes
255. Security
255.1. Authors
255.2. Summary of Module Globals
255.2.1.
255.2.2.
255.3. Global Functions
255.3.1. Abort
255.3.2. Export
255.3.3. GetModified
255.3.4. Import
255.3.5. Modified
255.3.6. Overview
255.3.7. PollAbort
255.3.8. Read
255.3.9. SetModified
255.3.10. Summary
255.3.11. Write
255.4. Global Variables
255.4.1. AbortFunction
255.4.2. PasswordMaxLengths
255.4.3. Settings
255.4.4. modified
255.5. Module Requirements
255.5.1. Module Imports
255.5.2. Module Includes
256. Sequencer
256.1. Authors
256.2. Summary of Module Globals
256.2.1.
256.2.2.
256.3. Global Functions
256.3.1. Run
256.4. Global Variables
256.5. Module Requirements
257. Service
257.1. Authors
257.2. Summary of Module Globals
257.2.1.
257.2.2.
257.3. Global Functions
257.3.1. Adjust
257.3.2. Disable
257.3.3. Enable
257.3.4. Enabled
257.3.5. EnabledServices
257.3.6. Error
257.3.7. Find
257.3.8. Finetune
257.3.9. FullInfo
257.3.10. Info
257.3.11. Reload
257.3.12. Restart
257.3.13. RunInitScript
257.3.14. RunInitScriptWithTimeOut
257.3.15. Start
257.3.16. Status
257.3.17. Stop
257.4. Global Variables
257.5. Module Requirements
258. SignatureCheckCallbacks
258.1. Authors
258.2. Summary of Module Globals
258.2.1.
258.2.2.
258.3. Global Functions
258.4. Global Variables
258.5. Module Requirements
258.5.1. Module Imports
258.5.2. Module Includes
259. SignatureCheckDialogs
259.1. Authors
259.2. Summary of Module Globals
259.2.1.
259.2.2.
259.3. Global Functions
259.3.1. CheckSignatures
259.3.2. CheckSignaturesInYaST
259.3.3. GetDefaultDialogReturn
259.3.4. GetShowThisPopup
259.3.5. ImportGPGKeyDialog
259.3.6. ImportGPGKeyIntoTrustedDialog
259.3.7. ItemSignedWithPublicSignature
259.3.8. ItemSignedWithUnknownSignature
259.3.9. SetDefaultDialogReturn
259.3.10. SetShowThisPopup
259.3.11. UseCorruptedItem
259.3.12. UseFileWithUnknownDigest
259.3.13. UseFileWithWrongDigest
259.3.14. UseItemWithNoChecksum
259.3.15. UseUnsignedItem
259.4. Global Variables
259.5. Module Requirements
259.5.1. Module Imports
259.5.2. Module Includes
260. SlideShow
260.1. Authors
260.2. Summary of Module Globals
260.2.1.
260.2.2.
260.3. Global Functions
260.3.1. AppendMessageToInstLog
260.3.2. ChangeSlideIfNecessary
260.3.3. CheckForSlides
260.3.4. CloseDialog
260.3.5. CurrentStageDescription
260.3.6. GenericHandleInput
260.3.7. GetSetup
260.3.8. GetUserAbort
260.3.9. GlobalProgressStart
260.3.10. HandleInput
260.3.11. HaveSlideWidget
260.3.12. MoveToStage
260.3.13. OpenDialog
260.3.14. RebuildDialog
260.3.15. Reset
260.3.16. ResetTimer
260.3.17. SetGlobalProgressLabel
260.3.18. SetLanguage
260.3.19. SetUserAbort
260.3.20. Setup
260.3.21. ShowingDetails
260.3.22. ShowingRelNotes
260.3.23. ShowingSlide
260.3.24. StageProgress
260.3.25. StartTimer
260.3.26. StopTimer
260.3.27. SubProgress
260.3.28. SubProgressStart
260.3.29. SwitchToDetailsView
260.3.30. SwitchToReleaseNotesView
260.3.31. SwitchToSlideView
260.3.32. TableItem
260.4. Global Variables
260.5. Module Requirements
260.5.1. Module Imports
260.5.2. Module Includes
261. SlideShowCallbacks
261.1. Authors
261.2. Summary of Module Globals
261.2.1.
261.2.2.
261.3. Global Functions
261.3.1. CallbackSourceChange
261.3.2. DisplayStartInstall
261.3.3. DonePackage
261.3.4. DoneProvide
261.3.5. FinishPatchDeltaProvide
261.3.6. InstallSlideShowCallbacks
261.3.7. ProgressDeltaApply
261.3.8. ProgressPackage
261.3.9. ProgressProvide
261.3.10. RemoveSlideShowCallbacks
261.3.11. StartDeltaApply
261.3.12. StartDeltaProvide
261.3.13. StartPackage
261.3.14. StartPatchProvide
261.3.15. StartProvide
261.4. Global Variables
261.5. Module Requirements
261.5.1. Module Imports
261.5.2. Module Includes
262. Slides
262.1. Authors
262.2. Summary of Module Globals
262.2.1.
262.2.2.
262.3. Global Functions
262.3.1. CheckBasePath
262.3.2. HaveSlideSupport
262.3.3. HaveSlides
262.3.4. LoadSlideFile
262.3.5. LoadSlides
262.3.6. SetSlideDir
262.4. Global Variables
262.5. Module Requirements
262.5.1. Module Imports
262.5.2. Module Includes
263. SlpServer
263.1. Authors
263.2. Summary of Module Globals
263.2.1.
263.2.2.
263.3. Global Functions
263.3.1. Abort
263.3.2. AutoPackages
263.3.3. Export
263.3.4. Import
263.3.5. Modified
263.3.6. Modified
263.3.7. Overview
263.3.8. Read
263.3.9. Summary
263.3.10. Write
263.4. Global Variables
263.4.1. modified
263.4.2. proposal_valid
263.4.3. write_only
263.5. Module Requirements
263.5.1. Module Imports
263.5.2. Module Includes
264. Sound
264.1. Authors
264.2. Summary of Module Globals
264.2.1.
264.2.2.
264.3. Global Functions
264.3.1. Changed
264.3.2. CollectOptions
264.3.3. CreateModprobeCommands
264.3.4. DetectHardware
264.3.5. DetectOldCards
264.3.6. Export
264.3.7. ForceReset
264.3.8. GetJoystickSettings
264.3.9. GetModified
264.3.10. GetSoundCardList
264.3.11. GetSoundCardListWithJoy
264.3.12. HasJoystick
264.3.13. Import
264.3.14. InitMixer
264.3.15. LoadDatabase
264.3.16. LoadPackageDatabase
264.3.17. ProbeOldChip
264.3.18. Propose
264.3.19. Read
264.3.20. ReadModulesConf
264.3.21. RequiredKernelModules
264.3.22. RestoreSettings
264.3.23. Set
264.3.24. SetModified
264.3.25. SetVolume
264.3.26. Sound
264.3.27. StoreMixer
264.3.28. StoreSettings
264.3.29. StoreUniqueKeys
264.3.30. Summary
264.3.31. UpdateUnconfiguredCards
264.3.32. Write
264.3.33. getConfigurableCards
264.4. Global Variables
264.4.1. STRINGS
264.4.2. card_id
264.4.3. configure_detected
264.4.4. curr_driver
264.4.5. curr_model
264.4.6. curr_vendor
264.4.7. db_indices
264.4.8. db_module_index
264.4.9. db_modules
264.4.10. db_vendors
264.4.11. default_volume
264.4.12. detected_cards
264.4.13. installation
264.4.14. modules_conf
264.4.15. modules_conf_b
264.4.16. proposal_created
264.4.17. rc_vars
264.4.18. removed_info
264.4.19. save_entry
264.4.20. skip_detection
264.4.21. unconfigured_cards
264.4.22. use_alsa
264.4.23. use_ui
264.4.24. used_modprobe_conf
264.4.25. volume_settings
264.4.26. write_only
264.5. Module Requirements
264.5.1. Module Imports
264.5.2. Module Includes
265. SourceDialogs
265.1. Authors
265.2. Summary of Module Globals
265.2.1.
265.2.2.
265.3. Global Functions
265.3.1. EditDialog
265.3.2. EditDialogProtocol
265.3.3. EditDialogProtocolService
265.3.4. EditPopup
265.3.5. EditPopupNoHTTPS
265.3.6. EditPopupService
265.3.7. EditPopupType
265.3.8. GetRepoName
265.3.9. GetURL
265.3.10. SetRepoName
265.3.11. SetURL
265.3.12. SetURLType
265.3.13. TypeDialog
265.3.14. TypeDialogDownloadOpt
265.3.15. TypePopup
265.4. Global Variables
265.5. Module Requirements
265.5.1. Module Imports
265.5.2. Module Includes
266. SourceManager
266.1. Authors
266.2. Summary of Module Globals
266.2.1.
266.2.2.
266.3. Global Functions
266.3.1. Abort
266.3.2. AbortFunction
266.3.3. AddUpdateSources
266.3.4. AskForCD
266.3.5. CommitSources
266.3.6. Export
266.3.7. GetSrcIdByIndex
266.3.8. GetSyncFlag
266.3.9. Import
266.3.10. InstInitSourceMoveDownloadArea
266.3.11. InstallationSourceOnPartition
266.3.12. Lock
266.3.13. Modified
266.3.14. Modified
266.3.15. Overview
266.3.16. Read
266.3.17. ReadSyncFlag
266.3.18. RunCommandWithTimeout
266.3.19. RunDumbTimeout
266.3.20. SetSyncFlag
266.3.21. SetUrlByIndex
266.3.22. SourceData
266.3.23. Summary
266.3.24. SyncAddedAndDeleted
266.3.25. SyncYaSTInstSourceWithZMD
266.3.26. Unlock
266.3.27. Write
266.3.28. WriteSyncFlag
266.3.29. createSource
266.3.30. deleteSourceByIndex
266.3.31. deleteSourceBySrcId
266.3.32. deleteSourceByUrl
266.3.33. getSourceId
266.4. Global Variables
266.4.1. modified
266.4.2. proposal_valid
266.5. Module Requirements
266.5.1. Module Imports
266.5.2. Module Includes
267. SourceManagerSLP
267.1. Authors
267.2. Summary of Module Globals
267.2.1.
267.2.2.
267.3. Global Functions
267.3.1. AddSourceTypeSLP
267.3.2. SelectOneSLPService
267.4. Global Variables
267.5. Module Requirements
267.5.1. Module Imports
267.5.2. Module Includes
268. SpaceCalculation
268.1. Authors
268.2. Summary of Module Globals
268.2.1.
268.2.2.
268.3. Global Functions
268.3.1. CheckDiskFreeSpace
268.3.2. EvaluateFreeSpace
268.4. Global Variables
268.5. Module Requirements
268.5.1. Module Imports
268.5.2. Module Includes
269. Squid
269.1. Authors
269.2. Summary of Module Globals
269.2.1.
269.2.2.
269.3. Global Functions
269.3.1. ACLIsUsedBy
269.3.2. Abort
269.3.3. Export
269.3.4. GetHttpPortsOnly
269.3.5. Import
269.3.6. IsServiceRunning
269.3.7. NumACLs
269.3.8. NumACLsByName
269.3.9. Read
269.3.10. StartService
269.3.11. StopService
269.3.12. Summary
269.3.13. Write
269.4. Global Variables
269.4.1. write_only
269.5. Module Requirements
269.5.1. Module Imports
269.5.2. Module Includes
270. SquidACL
270.1. Authors
270.2. Summary of Module Globals
270.2.1.
270.2.2.
270.3. Global Functions
270.3.1. GetOptions
270.3.2. GetTypesToComboBox
270.3.3. InitWidget
270.3.4. Replace
270.3.5. SupportedACLs
270.3.6. Verify
270.4. Global Variables
270.5. Module Requirements
270.5.1. Module Imports
270.5.2. Module Includes
271. SquidErrorMessages
271.1. Authors
271.2. Summary of Module Globals
271.2.1.
271.2.2.
271.3. Global Functions
271.3.1. GetLanguageFromPath
271.3.2. GetLanguages
271.3.3. GetLanguagesToComboBox
271.3.4. GetPath
271.4. Global Variables
271.5. Module Requirements
271.5.1. Module Imports
271.5.2. Module Includes
272. Sshd
272.1. Authors
272.2. Summary of Module Globals
272.2.1.
272.2.2.
272.3. Global Functions
272.3.1. Abort
272.3.2. Export
272.3.3. GetDefaultSSHDOption
272.3.4. GetModified
272.3.5. GetSSHDOption
272.3.6. Import
272.3.7. PollAbort
272.3.8. Read
272.3.9. SetModified
272.3.10. SetSSHDOption
272.3.11. Write
272.4. Global Variables
272.5. Module Requirements
272.5.1. Module Imports
272.5.2. Module Includes
273. SshdCommandLine
273.1. Authors
273.2. Summary of Module Globals
273.2.1.
273.2.2.
273.3. Global Functions
273.4. Global Variables
273.5. Module Requirements
273.5.1. Module Imports
273.5.2. Module Includes
274. Stage
274.1. Authors
274.2. Summary of Module Globals
274.2.1.
274.2.2.
274.3. Global Functions
274.3.1. Set
274.3.2. cont
274.3.3. firstboot
274.3.4. initial
274.3.5. normal
274.3.6. reprobe
274.3.7. stage
274.4. Global Variables
274.5. Module Requirements
275. Storage
275.1. Authors
275.2. Summary of Module Globals
275.2.1.
275.2.2.
275.3. Global Functions
275.3.1. AddFstabEntry
275.3.2. AddMountPointInfo
275.3.3. AddSwapMp
275.3.4. AddWinInfo
275.3.5. CheckForLvmRootFs
275.3.6. CheckSwapOn
275.3.7. CommitChanges
275.3.8. CreatePartition
275.3.9. DeletePartitionTable
275.3.10. DetectFs
275.3.11. GetDeviceName
275.3.12. GetDisk
275.3.13. GetDiskPartition
275.3.14. GetFreeSpace
275.3.15. GetMountPoints
275.3.16. GetOndiskTarget
275.3.17. GetOtherLinuxPartitions
275.3.18. GetPrimPartitions
275.3.19. GetTargetMap
275.3.20. HandleProposalPackages
275.3.21. InitializeDisk
275.3.22. IsPartitionable
275.3.23. IsRealDisk
275.3.24. IsResizable
275.3.25. Mount
275.3.26. MountOpt
275.3.27. ReReadTargetMap
275.3.28. ReadFstab
275.3.29. RemoveDmMapsTo
275.3.30. ResizePartition
275.3.31. ResizeVolume
275.3.32. SetPartitionData
275.3.33. SetPartitionFormat
275.3.34. SetPartitionId
275.3.35. SetPartitionMount
275.3.36. SwappingPartitions
275.3.37. Umount
275.3.38. UnchangePartitionId
275.3.39. Update
275.3.40. UpdateTargetMap
275.3.41. WriteFstab
275.3.42. getDiskInfo
275.4. Global Variables
275.5. Module Requirements
275.5.1. Module Imports
275.5.2. Module Includes
276. StorageClients
276.1. Authors
276.2. Summary of Module Globals
276.2.1.
276.2.2.
276.3. Global Functions
276.4. Global Variables
276.5. Module Requirements
276.5.1. Module Imports
276.5.2. Module Includes
277. StorageControllers
277.1. Authors
277.2. Summary of Module Globals
277.2.1.
277.2.2.
277.3. Global Functions
277.3.1. Initialize
277.3.2. Probe
277.3.3. StartHotplugStorage
277.4. Global Variables
277.5. Module Requirements
277.5.1. Module Imports
277.5.2. Module Includes
278. StorageDevices
278.1. Authors
278.2. Summary of Module Globals
278.2.1.
278.2.2.
278.3. Global Functions
278.4. Global Variables
278.5. Module Requirements
278.5.1. Module Imports
278.5.2. Module Includes
279. StorageFields
279.1. Authors
279.2. Summary of Module Globals
279.2.1.
279.2.2.
279.3. Global Functions
279.3.1. IterateTargetMap
279.3.2. OverviewContents
279.3.3. PredicateAll
279.3.4. PredicateDevice
279.3.5. PredicateDiskDevice
279.3.6. PredicateDiskType
279.3.7. PredicateUsedByDevice
279.3.8. TableContents
279.4. Global Variables
279.5. Module Requirements
279.5.1. Module Imports
279.5.2. Module Includes
280. StorageSettings
280.1. Authors
280.2. Summary of Module Globals
280.2.1.
280.2.2.
280.3. Global Functions
280.4. Global Variables
280.5. Module Requirements
280.5.1. Module Imports
280.5.2. Module Includes
281. String
281.1. Authors
281.2. Summary of Module Globals
281.2.1.
281.2.2.
281.3. Global Functions
281.3.1. CAlnum
281.3.2. CAlpha
281.3.3. CDigit
281.3.4. CGraph
281.3.5. CLower
281.3.6. CPrint
281.3.7. CPunct
281.3.8. CSpace
281.3.9. CUpper
281.3.10. CXdigit
281.3.11. CutBlanks
281.3.12. CutRegexMatch
281.3.13. CutZeros
281.3.14. EscapeTags
281.3.15. FirstChunk
281.3.16. FormatFilename
281.3.17. FormatRate
281.3.18. FormatRateMessage
281.3.19. FormatSize
281.3.20. FormatSizeWithPrecision
281.3.21. GetCommentLines
281.3.22. GetMetaDataLines
281.3.23. NewlineItems
281.3.24. NonEmpty
281.3.25. OptFormat
281.3.26. OptParens
281.3.27. Pad
281.3.28. PadZeros
281.3.29. ParseOptions
281.3.30. ParseSysconfigComment
281.3.31. Quote
281.3.32. Random
281.3.33. Replace
281.3.34. TextTable
281.3.35. UnQuote
281.3.36. UnderlinedHeader
281.3.37. ValidCharsFilename
281.3.38. WrapAt
281.4. Global Variables
281.5. Module Requirements
282. SuSEFirewall
282.1. Authors
282.2. Summary of Module Globals
282.2.1.
282.2.2.
282.3. Global Functions
282.3.1. ActivateConfiguration
282.3.2. AddForwardIntoMasqueradeRule
282.3.3. AddInterfaceIntoZone
282.3.4. AddService
282.3.5. AddSpecialInterfaceIntoZone
282.3.6. AddXenSupport
282.3.7. ConvertToServicesDefinedByPackages
282.3.8. DisableServices
282.3.9. EnableServices
282.3.10. Export
282.3.11. GetAcceptExpertRules
282.3.12. GetAdditionalServices
282.3.13. GetAllDialUpInterfaces
282.3.14. GetAllKnownInterfaces
282.3.15. GetAllNonDialUpInterfaces
282.3.16. GetBroadcastAllowedPorts
282.3.17. GetEnableService
282.3.18. GetFirewallInterfaces
282.3.19. GetFirewallInterfacesMap
282.3.20. GetFirewallKernelModules
282.3.21. GetIgnoreLoggingBroadcast
282.3.22. GetInterfacesInZone
282.3.23. GetInterfacesInZoneSupportingAnyFeature
282.3.24. GetKnownFirewallZones
282.3.25. GetListOfForwardsIntoMasquerade
282.3.26. GetListOfKnownInterfaces
282.3.27. GetLoggingSettings
282.3.28. GetMasquerade
282.3.29. GetModified
282.3.30. GetProtectFromInternalZone
282.3.31. GetProtocolTranslatedName
282.3.32. GetServices
282.3.33. GetServicesAcceptRelated
282.3.34. GetServicesInZones
282.3.35. GetSpecialInterfacesInZone
282.3.36. GetStartService
282.3.37. GetSupportRoute
282.3.38. GetTrustIPsecAs
282.3.39. GetZoneFullName
282.3.40. GetZoneOfInterface
282.3.41. GetZonesOfInterfaces
282.3.42. GetZonesOfInterfacesWithAnyFeatureSupported
282.3.43. HaveService
282.3.44. Import
282.3.45. InterfacesSupportedByAnyFeature
282.3.46. IsAnyNetworkInterfaceSupported
282.3.47. IsEnabled
282.3.48. IsInterfaceInZone
282.3.49. IsOtherFirewallRunning
282.3.50. IsServiceSupportedInZone
282.3.51. IsStarted
282.3.52. Read
282.3.53. RemoveForwardIntoMasqueradeRule
282.3.54. RemoveInterfaceFromZone
282.3.55. RemoveService
282.3.56. RemoveSpecialInterfaceFromZone
282.3.57. ResetModified
282.3.58. ResetReadFlag
282.3.59. SaveAndRestartService
282.3.60. SetAcceptExpertRules
282.3.61. SetAdditionalServices
282.3.62. SetBroadcastAllowedPorts
282.3.63. SetEnableService
282.3.64. SetFirewallKernelModules
282.3.65. SetIgnoreLoggingBroadcast
282.3.66. SetInstallPackagesIfMissing
282.3.67. SetLoggingSettings
282.3.68. SetMasquerade
282.3.69. SetModified
282.3.70. SetProtectFromInternalZone
282.3.71. SetServices
282.3.72. SetServicesAcceptRelated
282.3.73. SetServicesForZones
282.3.74. SetStartService
282.3.75. SetSupportRoute
282.3.76. SetTrustIPsecAs
282.3.77. StartServices
282.3.78. StopServices
282.3.79. SuSEFirewallIsInstalled
282.3.80. Write
282.3.81. WriteConfiguration
282.3.82. WriteOnly
282.4. Global Variables
282.4.1. max_port_number
282.4.2. special_all_interface_string
282.4.3. special_all_interface_zone
282.5. Module Requirements
282.5.1. Module Imports
282.5.2. Module Includes
283. SuSEFirewall4Network
283.1. Authors
283.2. Summary of Module Globals
283.2.1.
283.2.2.
283.3. Global Functions
283.3.1. ChangedByUser
283.3.2. FirewallZonesComboBoxItems
283.3.3. GetZoneOfInterface
283.3.4. IsOn
283.3.5. IsProtectedByFirewall
283.3.6. ProtectByFirewall
283.3.7. Read
283.3.8. UnconfiguredIsBlocked
283.3.9. Write
283.4. Global Variables
283.5. Module Requirements
283.5.1. Module Imports
283.5.2. Module Includes
284. SuSEFirewallExpertRules
284.1. Authors
284.2. Summary of Module Globals
284.2.1.
284.2.2.
284.3. Global Functions
284.3.1. AddNewAcceptRule
284.3.2. DeleteRuleID
284.3.3. GetAllExpertRulesProtocols
284.3.4. GetListOfAcceptRules
284.3.5. IsValidNetwork
284.3.6. RemoveAcceptRule
284.3.7. ValidNetwork
284.4. Global Variables
284.5. Module Requirements
284.5.1. Module Imports
284.5.2. Module Includes
285. SuSEFirewallProposal
285.1. Authors
285.2. Summary of Module Globals
285.2.1.
285.2.2.
285.3. Global Functions
285.3.1. GetChangedByUser
285.3.2. GetProposalInitialized
285.3.3. OpenServiceOnNonDialUpInterfaces
285.3.4. ProposalSummary
285.3.5. Propose
285.3.6. Reset
285.3.7. SetChangedByUser
285.3.8. SetProposalInitialized
285.4. Global Variables
285.5. Module Requirements
285.5.1. Module Imports
285.5.2. Module Includes
286. SuSEFirewallServices
286.1. Authors
286.2. Summary of Module Globals
286.2.1.
286.2.2.
286.3. Global Functions
286.3.1. GetFilenameFromServiceDefinedByPackage
286.3.2. GetListOfServicesAddedByPackage
286.3.3. GetModified
286.3.4. GetNeededBroadcastPorts
286.3.5. GetNeededIPProtocols
286.3.6. GetNeededPortsAndProtocols
286.3.7. GetNeededRPCPorts
286.3.8. GetNeededTCPPorts
286.3.9. GetNeededUDPPorts
286.3.10. GetPossiblyConflictServices
286.3.11. GetSupportedServices
286.3.12. IsKnownService
286.3.13. ReadServicesDefinedByRPMPackages
286.3.14. ResetModified
286.3.15. ServiceDefinedByPackage
286.3.16. SetModified
286.3.17. SetNeededPortsAndProtocols
286.4. Global Variables
286.5. Module Requirements
286.5.1. Module Imports
286.5.2. Module Includes
287. SuSERelease
287.1. Authors
287.2. Summary of Module Globals
287.2.1.
287.2.2.
287.3. Global Functions
287.3.1. ReleaseInformation
287.3.2. ReleaseName
287.3.3. ReleaseVersion
287.4. Global Variables
287.5. Module Requirements
287.5.1. Module Imports
287.5.2. Module Includes
288. Sudo
288.1. Authors
288.2. Summary of Module Globals
288.2.1.
288.2.2.
288.3. Global Functions
288.3.1. GetModified
288.3.2. PollAbort
288.3.3. Read
288.3.4. Write
288.4. Global Variables
288.5. Module Requirements
288.5.1. Module Imports
288.5.2. Module Includes
289. Summary
289.1. Authors
289.2. Summary of Module Globals
289.2.1.
289.2.2.
289.3. Global Functions
289.3.1. AddHeader
289.3.2. AddLine
289.3.3. AddListItem
289.3.4. AddNewLine
289.3.5. AddSimpleSection
289.3.6. CloseList
289.3.7. Device
289.3.8. DevicesList
289.3.9. NotConfigured
289.3.10. OpenList
289.4. Global Variables
289.5. Module Requirements
289.5.1. Module Imports
289.5.2. Module Includes
290. Support
290.1. Authors
290.2. Summary of Module Globals
290.2.1.
290.2.2.
290.3. Global Functions
290.3.1. Abort
290.3.2. AutoPackages
290.3.3. Export
290.3.4. Import
290.3.5. Modified
290.3.6. Modified
290.3.7. Overview
290.3.8. Read
290.3.9. SetModified
290.3.10. SetWriteOnly
290.3.11. Summary
290.3.12. Write
290.3.13. WriteOnly
290.4. Global Variables
290.4.1. root_pw
290.5. Module Requirements
290.5.1. Module Imports
290.5.2. Module Includes
291. Sysconfig
291.1. Authors
291.2. Summary of Module Globals
291.2.1.
291.2.2.
291.3. Global Functions
291.3.1. Export
291.3.2. Import
291.3.3. Modified
291.3.4. Read
291.3.5. RegisterAgents
291.3.6. Search
291.3.7. Set
291.3.8. Summary
291.3.9. Write
291.3.10. get_all
291.3.11. get_all_names
291.3.12. get_description
291.3.13. get_file_from_id
291.3.14. get_location_from_id
291.3.15. get_metadata
291.3.16. get_modified
291.3.17. get_name_from_id
291.3.18. get_only_comment
291.3.19. modified
291.3.20. parse_metadata
291.3.21. remove_whitespaces
291.3.22. set_value
291.4. Global Variables
291.5. Module Requirements
291.5.1. Module Imports
291.5.2. Module Includes
292. SystemFilesCopy
292.1. Authors
292.2. Summary of Module Globals
292.2.1.
292.2.2.
292.3. Global Functions
292.3.1. CopyFilesToSystem
292.3.2. CopyFilesToTemp
292.3.3. CreateDirectoryIfMissing
292.3.4. GetCopySystemFiles
292.3.5. GetUseControlFileDef
292.3.6. SaveInstSysContent
292.3.7. SetCopySystemFiles
292.3.8. SetUseControlFileDef
292.4. Global Variables
292.5. Module Requirements
292.5.1. Module Imports
292.5.2. Module Includes
293. SystemProfile
293.1. Authors
293.2. Summary of Module Globals
293.2.1.
293.2.2.
293.3. Global Functions
293.3.1. AutoPackages
293.3.2. Export
293.3.3. Import
293.3.4. Modified
293.3.5. Read
293.3.6. SetModified
293.3.7. Write
293.3.8. executeSmoltCmd
293.4. Global Variables
293.4.1. moduleTitle
293.5. Module Requirements
293.5.1. Module Imports
293.5.2. Module Includes
294. SystemSettings
294.1. Authors
294.2. Summary of Module Globals
294.2.1.
294.2.2.
294.3. Global Functions
294.4. Global Variables
294.5. Module Requirements
294.5.1. Module Imports
294.5.2. Module Includes
295. TFTP
295.1. Authors
295.2. Summary of Module Globals
295.2.1.
295.2.2.
295.3. Global Functions
295.3.1. Get
295.3.2. Put
295.4. Global Variables
295.5. Module Requirements
296. TabPanel
296.1. Authors
296.2. Summary of Module Globals
296.2.1.
296.2.2.
296.3. Global Functions
296.3.1. Init
296.4. Global Variables
296.5. Module Requirements
297. TablePopup
297.1. Authors
297.2. Summary of Module Globals
297.2.1.
297.2.2.
297.3. Global Functions
297.3.1. CreateTableDescr
297.3.2. DisableTable
297.3.3. EnableTable
297.3.4. TableHandle
297.3.5. TableHandleWrapper
297.3.6. TableInit
297.3.7. TableInitWrapper
297.3.8. askForNewOption
297.3.9. deleteTableItem
297.3.10. id2key
297.3.11. key2descr
297.3.12. singleOptionEditPopup
297.3.13. tableEntryChanged
297.3.14. updateButtons
297.3.15. updateOptionMap
297.4. Global Variables
297.5. Module Requirements
297.5.1. Module Imports
297.5.2. Module Includes
298. Taotie
298.1. Authors
298.2. Summary of Module Globals
298.2.1.
298.2.2.
298.3. Global Functions
298.3.1. Abort
298.3.2. AutoPackages
298.3.3. Export
298.3.4. Import
298.3.5. Modified
298.3.6. Modified
298.3.7. Overview
298.3.8. Summary
298.4. Global Variables
298.4.1. modified
298.4.2. proposal_valid
298.4.3. write_only
298.5. Module Requirements
298.5.1. Module Imports
298.5.2. Module Includes
299. Testsuite
299.1. Authors
299.2. Summary of Module Globals
299.2.1.
299.2.2.
299.3. Global Functions
299.3.1. Dump
299.3.2. DumpFile
299.3.3. Init
299.3.4. Test
299.4. Global Variables
299.5. Module Requirements
300. TftpServer
300.1. Authors
300.2. Summary of Module Globals
300.2.1.
300.2.2.
300.3. Global Functions
300.3.1. AutoPackages
300.3.2. Export
300.3.3. ForeignServersError
300.3.4. GetModified
300.3.5. Import
300.3.6. ParseServerArgs
300.3.7. Read
300.3.8. Set
300.3.9. SetModified
300.3.10. Summary
300.3.11. Write
300.3.12. WriteOnly
300.4. Global Variables
300.4.1. directory
300.4.2. foreign_servers
300.4.3. other_args
300.4.4. required_packages
300.4.5. start
300.5. Module Requirements
300.5.1. Module Imports
300.5.2. Module Includes
301. Timezone
301.1. Authors
301.2. Summary of Module Globals
301.2.1.
301.2.2.
301.3. Global Functions
301.3.1. Export
301.3.2. GetCountryForTimezone
301.3.3. GetDateTime
301.3.4. GetDateTimeMap
301.3.5. GetLanguageForTimezone
301.3.6. GetTimezoneCountry
301.3.7. GetTimezoneForLanguage
301.3.8. Import
301.3.9. MakeProposal
301.3.10. Modified
301.3.11. PopVal
301.3.12. ProposeLocaltime
301.3.13. PushVal
301.3.14. Read
301.3.15. Region
301.3.16. ResetZonemap
301.3.17. Save
301.3.18. Selection
301.3.19. Set
301.3.20. SetTime
301.3.21. SetTimezoneForLanguage
301.3.22. Summary
301.3.23. SystemTime2HWClock
301.3.24. Timezone
301.3.25. UpdateTimezone
301.3.26. get_zonemap
301.4. Global Variables
301.4.1. modified
301.4.2. windows_partition
301.5. Module Requirements
301.5.1. Module Imports
301.5.2. Module Includes
302. TreePanel
302.1. Authors
302.2. Summary of Module Globals
302.2.1.
302.2.2.
302.3. Global Functions
302.3.1. Destroy
302.3.2. Handle
302.3.3. Init
302.3.4. Update
302.4. Global Variables
302.5. Module Requirements
303. Tv
303.1. Authors
303.2. Summary of Module Globals
303.2.1.
303.2.2.
303.3. Global Functions
303.3.1. CardAddCurrent
303.3.2. CardGet
303.3.3. CardIndexUniqKey
303.3.4. CardRemove
303.3.5. CardReplaceWithCurrent
303.3.6. CardsAsItemMap
303.3.7. CardsAsItems
303.3.8. CardsDBVendorGetCards
303.3.9. CardsDBVendorsAsItems
303.3.10. CardsUniqueKeys
303.3.11. Detect
303.3.12. DetectedCardGet
303.3.13. DetectedCardsAsItems
303.3.14. Export
303.3.15. GetIRCModule
303.3.16. GetKernelModuleInfo
303.3.17. GetTuner
303.3.18. GetTvCard
303.3.19. Import
303.3.20. InitializeStationsConfig
303.3.21. InstalledCardsSummary
303.3.22. IsDirty
303.3.23. LoadIRCModulesDescription
303.3.24. ModuleParametersAsItems
303.3.25. ModulesAsItems
303.3.26. Propose
303.3.27. Read
303.3.28. ReadCardsDatabase
303.3.29. ReadIRC
303.3.30. ReadKernelModules
303.3.31. ReadSettings
303.3.32. ReadStationsConfig
303.3.33. ReadTunersDatabase
303.3.34. ReadUserSettings
303.3.35. Summary
303.3.36. TunersDBAsItems
303.3.37. TunersDBHasTunersFor
303.3.38. TunersDBSelectTuner
303.3.39. Write
303.3.40. WriteIRC
303.3.41. WriteStationsConfig
303.3.42. tv_tmp_start
303.4. Global Variables
303.4.1. cards_database
303.4.2. channels_config
303.4.3. current_card
303.4.4. current_card_no
303.4.5. irc_config
303.4.6. irc_modified
303.4.7. irc_module
303.4.8. irc_modules
303.4.9. irc_modules_list
303.4.10. kernel_modules
303.4.11. not_ask
303.4.12. proposal_valid
303.4.13. remotes
303.4.14. stations_modified
303.4.15. use_irc
303.4.16. used_modprobe_conf
303.5. Module Requirements
303.5.1. Module Imports
303.5.2. Module Includes
304. TypeRepository
304.1. Authors
304.2. Summary of Module Globals
304.2.1.
304.2.2.
304.3. Global Functions
304.3.1. TypeRepository
304.3.2. enum_validator
304.3.3. is_a
304.3.4. regex_validator
304.4. Global Variables
304.5. Module Requirements
304.5.1. Module Imports
304.5.2. Module Includes
305. URL
305.1. Authors
305.2. Summary of Module Globals
305.2.1.
305.2.2.
305.3. Global Functions
305.3.1. Build
305.3.2. Check
305.3.3. EscapeString
305.3.4. FormatURL
305.3.5. HidePassword
305.3.6. HidePasswordToken
305.3.7. MakeMapFromParams
305.3.8. MakeParamsFromMap
305.3.9. Parse
305.3.10. UnEscapeString
305.4. Global Variables
305.4.1. transform_map_filename
305.4.2. transform_map_passwd
305.4.3. transform_map_query
305.5. Module Requirements
305.5.1. Module Imports
305.5.2. Module Includes
306. Update
306.1. Authors
306.2. Summary of Module Globals
306.2.1.
306.2.2.
306.3. Global Functions
306.3.1. Detach
306.3.2. DropObsoletePackages
306.3.3. GetBaseSelections
306.3.4. GetProductName
306.3.5. InitUpdate
306.3.6. IsProductSupportedForUpgrade
306.3.7. OnlyUpdateInstalled
306.3.8. ProductsCompatible
306.3.9. ProposeSelection
306.3.10. Reset
306.3.11. SilentlyDowngradePackages
306.3.12. fill_version_map
306.4. Global Variables
306.5. Module Requirements
306.5.1. Module Imports
306.5.2. Module Includes
307.
307.1. Authors
307.2. Summary of Module Globals
307.2.1.
307.2.2.
307.3. Global Functions
307.3.1. GetBooleanValue
307.3.2. GetIntegerValue
307.3.3. GetStringValue
307.3.4. GetValue
307.3.5. SetValue
307.4. Global Variables
307.5. Module Requirements
307.5.1. Module Imports
307.5.2. Module Includes
308. UsersUI
308.1. Authors
308.2. Summary of Module Globals
308.2.1.
308.2.2.
308.3. Global Functions
308.3.1. GetPasswdErrorMessage
308.3.2. HashPassword
308.3.3. ReadNISConfigurationType
308.3.4. RecodeUTF
308.3.5. SystemUserName
308.4. Global Variables
308.5. Module Requirements
308.5.1. Module Imports
308.5.2. Module Includes
309. VM_XEN
309.1. Authors
309.2. Summary of Module Globals
309.2.1.
309.2.2.
309.3. Global Functions
309.4. Global Variables
309.5. Module Requirements
309.5.1. Module Imports
309.5.2. Module Includes
310. ValueBrowser
310.1. Authors
310.2. Summary of Module Globals
310.2.1.
310.2.2.
310.3. Global Functions
310.3.1. BrowseTree
310.3.2. BrowseTreeHelper
310.3.3. DebugBrowse
310.3.4. DebugBrowseHelper
310.4. Global Variables
310.5. Module Requirements
310.5.1. Module Imports
310.5.2. Module Includes
311. Vendor
311.1. Authors
311.2. Summary of Module Globals
311.2.1.
311.2.2.
311.3. Global Functions
311.3.1. DriverUpdate1
311.4. Global Variables
311.5. Module Requirements
311.5.1. Module Imports
311.5.2. Module Includes
312. Version
312.1. Authors
312.2. Summary of Module Globals
312.2.1.
312.2.2.
312.3. Global Functions
312.4. Global Variables
312.4.1. yast2
312.5. Module Requirements
313. WOL
313.1. Authors
313.2. Summary of Module Globals
313.2.1.
313.2.2.
313.3. Global Functions
313.4. Global Variables
313.5. Module Requirements
313.5.1. Module Imports
313.5.2. Module Includes
314. WebpinPackageSearch
314.1. Authors
314.2. Summary of Module Globals
314.2.1.
314.2.2.
314.3. Global Functions
314.3.1. GetBaseSearchURL
314.3.2. MatchesCurrentArchitecture
314.3.3. PrepareOneClickInstallDescription
314.3.4. SearchForPackages
314.3.5. SetBaseSearchURL
314.4. Global Variables
314.5. Module Requirements
314.5.1. Module Imports
314.5.2. Module Includes
315. Wizard
315.1. Authors
315.2. Summary of Module Globals
315.2.1.
315.2.2.
315.3. Global Functions
315.3.1. AbortAcceptButtonBox
315.3.2. AbortApplyFinishButtonBox
315.3.3. AbortInstallationAcceptButtonBox
315.3.4. AcceptDialog
315.3.5. AddMenu
315.3.6. AddMenuEntry
315.3.7. AddSubMenu
315.3.8. AddTreeItem
315.3.9. BackAbortInstallationNextButtonBox
315.3.10. BackAbortNextButtonBox
315.3.11. BackNextButtonBox
315.3.12. CancelAcceptButtonBox
315.3.13. CancelOKButtonBox
315.3.14. ClearContents
315.3.15. ClearTitleIcon
315.3.16. CloseDialog
315.3.17. CreateDialog
315.3.18. CreateMenu
315.3.19. CreateTree
315.3.20. CreateTreeDialog
315.3.21. DeleteMenus
315.3.22. DeleteTreeItems
315.3.23. DisableAbortButton
315.3.24. DisableBackButton
315.3.25. DisableCancelButton
315.3.26. DisableNextButton
315.3.27. EnableAbortButton
315.3.28. EnableBackButton
315.3.29. EnableCancelButton
315.3.30. EnableNextButton
315.3.31. GenericDialog
315.3.32. GenericTreeDialog
315.3.33. HideAbortButton
315.3.34. HideBackButton
315.3.35. HideNextButton
315.3.36. HideReleaseNotesButton
315.3.37. IsWizardDialog
315.3.38. NextBackDialog
315.3.39. OKDialog
315.3.40. OpenAbortApplyFinishDialog
315.3.41. OpenAcceptAbortStepsDialog
315.3.42. OpenAcceptDialog
315.3.43. OpenAcceptStepsDialog
315.3.44. OpenCustomDialog
315.3.45. OpenDialog
315.3.46. OpenNextBackDialog
315.3.47. OpenNextBackStepsDialog
315.3.48. OpenOKDialog
315.3.49. OpenTreeNextBackDialog
315.3.50. QueryTreeItem
315.3.51. ReplaceCustomHelp
315.3.52. ReplaceHelp
315.3.53. RestoreAbortButton
315.3.54. RestoreBackButton
315.3.55. RestoreHelp
315.3.56. RestoreNextButton
315.3.57. RestoreScreenShotName
315.3.58. RetranslateButtons
315.3.59. SelectTreeItem
315.3.60. SetAbortButton
315.3.61. SetBackButton
315.3.62. SetContents
315.3.63. SetContentsButtons
315.3.64. SetContentsFocus
315.3.65. SetDesktopIcon
315.3.66. SetDesktopTitle
315.3.67. SetDialogTitle
315.3.68. SetFocusToBackButton
315.3.69. SetFocusToNextButton
315.3.70. SetHelpText
315.3.71. SetNextButton
315.3.72. SetProductName
315.3.73. SetScreenShotName
315.3.74. SetTitleIcon
315.3.75. ShowHelp
315.3.76. ShowReleaseNotesButton
315.3.77. TimeoutUserInput
315.3.78. UserInput
315.3.79. WaitForEvent
315.4. Global Variables
315.5. Module Requirements
315.5.1. Module Imports
315.5.2. Module Includes
316. WizardHW
316.1. Authors
316.2. Summary of Module Globals
316.2.1.
316.2.2.
316.3. Global Functions
316.3.1. CreateHWDialog
316.3.2. CreateRichTextDescription
316.3.3. CreateWidget
316.3.4. RunHWDialog
316.3.5. SelectedItem
316.3.6. SetContents
316.3.7. SetRichDescription
316.3.8. SetSelectedItem
316.3.9. UnconfiguredDevice
316.3.10. UserInput
316.3.11. WaitForEvent
316.4. Global Variables
316.5. Module Requirements
316.5.1. Module Imports
316.5.2. Module Includes
317. Wizard_hw
317.1. Authors
317.2. Summary of Module Globals
317.2.1.
317.2.2.
317.3. Global Functions
317.3.1. ConfiguredContent
317.3.2. DetectedContent
317.3.3. SizeAtLeast
317.3.4. SpacingAround
317.4. Global Variables
317.5. Module Requirements
318. WorkflowManager
318.1. Authors
318.2. Summary of Module Globals
318.2.1.
318.2.2.
318.3. Global Functions
318.3.1. AddWorkflow
318.3.2. CleanWorkflowsDirectory
318.3.3. DumpCurrentSettings
318.3.4. GetAdditionalFinishSteps
318.3.5. GetAllUsedControlFiles
318.3.6. HaveAdditionalWorkflows
318.3.7. MergeWorkflows
318.3.8. PrepareProposals
318.3.9. PrepareSystemProposals
318.3.10. PrepareSystemWorkflows
318.3.11. PrepareWorkflows
318.3.12. RedrawWizardSteps
318.3.13. RemoveWorkflow
318.3.14. ResetWorkflow
318.3.15. SetAllUsedControlFiles
318.3.16. SetBaseWorkflow
318.3.17. SomeWorkflowsWereChanged
318.4. Global Variables
318.4.1. additional_finish_steps_before_chroot
318.5. Module Requirements
318.5.1. Module Imports
318.5.2. Module Includes
319. X11Version
319.1. Authors
319.2. Summary of Module Globals
319.2.1.
319.2.2.
319.3. Global Functions
319.4. Global Variables
319.5. Module Requirements
319.5.1. Module Imports
319.5.2. Module Includes
320. XML
320.1. Authors
320.2. Summary of Module Globals
320.2.1.
320.2.2.
320.3. Global Functions
320.3.1. XMLError
320.3.2. XMLToYCPFile
320.3.3. XMLToYCPString
320.3.4. YCPToXMLFile
320.3.5. xmlCreateDoc
320.4. Global Variables
320.5. Module Requirements
321. XMessages
321.1. Authors
321.2. Summary of Module Globals
321.2.1.
321.2.2.
321.3. Global Functions
321.4. Global Variables
321.5. Module Requirements
322. XVersion
322.1. Authors
322.2. Summary of Module Globals
322.2.1.
322.2.2.
322.3. Global Functions
322.3.1. Path
322.3.2. binPath
322.3.3. fontPath
322.3.4. includePath
322.3.5. infoPath
322.3.6. lib64Path
322.3.7. libPath
322.3.8. manPath
322.3.9. sharePath
322.4. Global Variables
322.5. Module Requirements
323. Xpram
323.1. Authors
323.2. Summary of Module Globals
323.2.1.
323.2.2.
323.3. Global Functions
323.3.1. Read
323.3.2. ReadSysconfig
323.3.3. Write
323.4. Global Variables
323.4.1. force
323.4.2. fstype
323.4.3. modified
323.4.4. mountpoint
323.4.5. start
323.5. Module Requirements
323.5.1. Module Imports
323.5.2. Module Includes
324. Y2ModuleConfig
324.1. Authors
324.2. Summary of Module Globals
324.2.1.
324.2.2.
324.3. Global Functions
324.3.1. Deps
324.3.2. SetDesktopIcon
324.3.3. Y2ModuleConfig
324.3.4. getResource
324.3.5. getResourceData
324.4. Global Variables
324.4.1. MenuTreeData
324.5. Module Requirements
324.5.1. Module Imports
324.5.2. Module Includes
325. ZFCPController
325.1. Authors
325.2. Summary of Module Globals
325.2.1.
325.2.2.
325.3. Global Functions
325.3.1. Abort
325.3.2. ActivateDisk
325.3.3. AutoPackages
325.3.4. Available
325.3.5. DeactivateDisk
325.3.6. Export
325.3.7. GetControllers
325.3.8. HexNumSize
325.3.9. Import
325.3.10. IsAvailable
325.3.11. Modified
325.3.12. Modified
325.3.13. ProbeDisks
325.3.14. Read
325.3.15. Summary
325.3.16. Write
325.4. Global Variables
325.4.1. modified
325.4.2. proposal_valid
325.4.3. write_only
325.5. Module Requirements
325.5.1. Module Imports
325.5.2. Module Includes

Abstract

Attention! API of all YaST modules is still marked unstable and could change without any preceding warning.

1. ALog

Admin's Log, producing a summary of what YaST did to the system

1.1. Authors

  • Martin Vidner <mvidner@suse.cz>

1.2. Summary of Module Globals

List of Global Functions

  • CommitPopup - Prompt the user for a message to describe the changes that she did using YaST, logs it using @ref Note

  • Item - Log a change to the system from the system point of view. msg should include the file being changed, and what changes are made (TODO: with all detail? or summary?) Example "/etc/ntp.conf: added 'server ntp.example.org'"

  • Note - Log a change to the system from the human point of view. (It will appear slightly differently in the log) Example "get proper time from the corporate time server as requested in ticket bofh#327"

List of Global Variables

    1.3. Global Functions

    1.3.1. CommitPopup

    Prompt the user for a message to describe the changes that she did using YaST, logs it using @ref Note

    Return value

    • void

    1.3.2. Item

    Log a change to the system from the system point of view. msg should include the file being changed, and what changes are made (TODO: with all detail? or summary?) Example "/etc/ntp.conf: added 'server ntp.example.org'"

    Function parameters

    • string msg

    Return value

    • void

    1.3.3. Note

    Log a change to the system from the human point of view. (It will appear slightly differently in the log) Example "get proper time from the corporate time server as requested in ticket bofh#327"

    Function parameters

    • string msg

    Return value

    • void

    1.4. Global Variables

    1.5. Module Requirements

    1.5.1. Module Imports

    • Label

    1.5.2. Module Includes

      2. AddOnCreator

      2.1. Authors

        2.2. Summary of Module Globals

        List of Global Functions

        List of Global Variables

        • add_on_products - list of all configured AddOn products

        • bootable - if final Add-On should be bootable (feature not implemented)

        • clone - if we have 'source add-on' to base the new one on

        • content - variables from content file + their description

        • content_key - argument for any_xml agent: key indicating content of element without attributes

        • current_product - map of the Add-On product currently in use

        • generate_descriptions - if the descriptions of packages should be generated (false have only sense when cloning where they could be read from description files of cloned product)

        • import_path - path to directory with existing product (which is being cloned)

        • modified - Data was modified?

        2.3. Global Functions

        2.3.1. BuildAddOn

        Write all add-on-creator settings

        Return value

        • boolean - true on success

        2.3.2. CommitCurrentProduct

        save the data with current configuration into global list + reset the current product map

        Return value

        • void

        2.3.3. CopyRPMs

        Copy the packages from the source directory to target

        Function parameters

        • string in_path

        • string base_path

        Return value

        • boolean - success

        2.3.4. CreateAddOnStructure

        Create the directory structure of the Add-On

        Function parameters

        • string base_path

        Return value

        • boolean - success

        2.3.5. CreateDirectoryYaSTFiles

        Create directory.yast files (the last step)

        Function parameters

        • string base_path

        Return value

        • boolean - success

        2.3.6. CreateISOImage

        Create an ISO image of the product

        Function parameters

        • string dir_path

        • string iso_p

        • string name

        Return value

        • boolean

        2.3.7. CreateMD5SUMS

        Create MD5SUMS files

        Function parameters

        • string base_path

        Return value

        • boolean - success

        2.3.8. Export

        Export the settings about current Add-On product

        Return value

        • map

        2.3.9. GenerateArchiveFiles

        Generate ARCHIVES.gz, INDEX.gz and ls-lR.gz

        Function parameters

        • string base_path

        Return value

        • boolean

        2.3.10. GenerateDirectories

        generate the paths of media, data and description dirs

        Function parameters

        • string base_path

        Return value

        • void

        2.3.11. GenerateGPGKey

        Generate the key pair

        Function parameters

        • map<string,string> data

        Return value

        • string

        2.3.12. GeneratePackageDescriptions

        Generate the package descriptions using create_package_descr

        Return value

        • boolean

        2.3.13. GenerateReleasePackage

        Use BuildService tools to create -release package with product info

        Function parameters

        • string base_path

        Return value

        • boolean

        2.3.14. GetKeyUID

        read the user's ID for given GPG key

        Function parameters

        • string key

        Return value

        • string

        2.3.15. GetProductInfo

        Get the map describing product.xml and produce better readable YCP map

        Function parameters

        • map xml

        • boolean merge_with_current

        Return value

        • map<string,map>

        2.3.16. ImportExistingProduct

        import the data from existing add-on

        Function parameters

        • string dir_path

        Return value

        • boolean

        2.3.17. Modified

        Data was modified?

        Return value

        • boolean - true if modified

        2.3.18. PrepareBuild

        prepare the data of current product for a build (neccessary because input packages could get changed)

        Return value

        • boolean

        2.3.19. Read

        Initialize the settings for add-on-creator

        Return value

        • boolean - true on success

        2.3.20. ReadPatternsFile

        read all the patterns defined in given file

        Function parameters

        • string file_path

        Return value

        • list<map> - of pattern maps

        2.3.21. ReadProductXML

        import the data from given xml file

        Function parameters

        • string prod_file_path

        Return value

        • map<string,any>

        2.3.22. ResetCurrentProduct

        Reset all settings related to current product

        Return value

        • void

        2.3.23. SignAddOn

        Sign current Add-On product

        Function parameters

        • string base_path

        • string key

        Return value

        • boolean

        2.3.24. UpdateContentMap

        Take list of content-file data and update global content_map. If argument is empty, global 'content' list is used as an input.

        Function parameters

        • list<map> content_list

        Return value

        • map<string,string>

        2.3.25. Write

        Write all AddOn products configurations

        Return value

        • boolean

        2.3.26. WriteContentFile

        Write the content file

        Function parameters

        • string base_path

        • list<map> content_data

        Return value

        • boolean - success

        2.3.27. WriteLicensesFiles

        Write the text of available licenses to correct places

        Function parameters

        • string descr_path

        • string base_path

        • map<string,string> files

        Return value

        • boolean

        2.3.28. WriteMediaFiles

        Write the media.n/media files

        Function parameters

        • string base_path

        • list<string> m_files

        • string next

        Return value

        • boolean - success

        2.3.29. WritePackageDescriptions

        Write the package descriptions edited by user

        Function parameters

        • string descr_path

        • map descr

        Return value

        • boolean

        2.3.30. WritePatchesFiles

        Create the patches files

        Function parameters

        • string base_path

        • list<string> p_files

        Return value

        • boolean - success

        2.3.31. WritePatterns

        Write all files with patterns definitions

        Function parameters

        • string descr_path

        • string base_path

        Return value

        • boolean

        2.3.32. WriteProductsFiles

        Create the products file TODO editor - see ExpertSettingsDialog3

        Function parameters

        • string base_path

        • list<string> p_files

        Return value

        • boolean - success

        2.3.33. WriteStringFiles

        Write the readme/COPYING/COPYRIGHT... files in base_path

        Function parameters

        • string base_path

        • map<string,string> files

        Return value

        • boolean - success

        2.4. Global Variables

        2.4.1. add_on_products

        list of all configured AddOn products

        2.4.2. bootable

        if final Add-On should be bootable (feature not implemented)

        2.4.3. clone

        if we have 'source add-on' to base the new one on

        2.4.4. content

        variables from content file + their description

        2.4.5. content_key

        argument for any_xml agent: key indicating content of element without attributes

        2.4.6. current_product

        map of the Add-On product currently in use

        2.4.7. generate_descriptions

        if the descriptions of packages should be generated (false have only sense when cloning where they could be read from description files of cloned product)

        2.4.8. import_path

        path to directory with existing product (which is being cloned)

        2.4.9. modified

        Data was modified?

        2.5. Module Requirements

        2.5.1. Module Imports

        • Arch
        • Directory
        • FileUtils
        • Label
        • Mode
        • Package
        • PackageSystem
        • PackagesDescr
        • Popup
        • Progress
        • Report
        • String

        2.5.2. Module Includes

          3. AddOnProduct

          This module provides integration of the add-on products

          3.1. Authors

          • Jiri Srain <jsrain@suse.de>

          • Lukas Ocilka <locilka@suse.cz>

          3.2. Summary of Module Globals

          List of Global Functions

          • AcceptedLicenseAndInfoFile - Show /media.1/info.txt file in a pop-up message if such file exists. Show license if such exists and return whether users accepts it. Returns 'nil' when did not succed.

          • AddOnMode - Returns whether add-on product got as parameter (source id) replaces some already installed add-on or whether it is a new installation. Repositories and target have to be initialized.

          • AddPreselectedAddOnProducts - Auto-integrate add-on products in specified file (usually add_on_products file)

          • Disintegrate - Opposite to Integrate()

          • DoInstall - Do installation of the add-on product within an installed system srcid is got via AddOnProduct::src_id

          • Export - Returns map describing all used add-ons.

          • GetAbsoluteURL - Returns an absolute URL from base + relative url. Relative URL needs to start with 'reulrl://' othewise it is not considered being relative and it's returned as it is (just the relative_url parameter).

          • Integrate - Integrate the add-on product to the installation workflow, including preparations for 2nd stage and inst-sys update

          • PrepareForRegistration - Checks whether the content file of the add-on has a flag REGISTERPRODUCT set to "true" or "yes". If it has, product is added into list of pruducts that need registration. Cached content file is used if possible.

          • ProcessRegistration - Returns whether registration is requested by at least one of used Add-On products.

          • ReIntegrateFromScratch - Some product(s) were removed, reintegrating their control files from scratch.

          • ReadTmpExportFilename - Reads the Add-Ons configuration stored on disk during the first stage installation.

          • RegisterAddOnProduct - Calls registration client if needed.

          • RemoveRegistrationFlag - Add-On product might have been added into products requesting registration. This pruduct has been removed (during configuring list of add-on products).

          • RereadAllSCRAgents - New add-on product might add also new agents. Functions Rereads all available agents.

          • SetPreselectedAddOnProductsType - Sets an add_on_products file type ("plain" or "xml")

          • TmpExportFilename - Returns the path where Add-Ons configuration is stored during the fist stage installation. This path reffers to the installed system.

          • UpdateInstSys - Adapts the inst-sys from the tarball

          List of Global Variables

          • add_on_products - List of all selected repositories

          • last_ret - return value of last step in the product adding workflow

          • src_id - ID of currently added repository for the add-on product

          3.3. Global Functions

          3.3.1. AcceptedLicenseAndInfoFile

          Show /media.1/info.txt file in a pop-up message if such file exists. Show license if such exists and return whether users accepts it. Returns 'nil' when did not succed.

          Function parameters

          • integer src_id

          Return value

          • boolean - whether the license has been accepted

          3.3.2. AddOnMode

          Returns whether add-on product got as parameter (source id) replaces some already installed add-on or whether it is a new installation. Repositories and target have to be initialized.

          Function parameters

          • integer source_id

          Return value

          • string

          3.3.3. AddPreselectedAddOnProducts

          Auto-integrate add-on products in specified file (usually add_on_products file)

          Function parameters

          • string filelist

          Return value

          • boolean - true on exit

           Format of /add_on_products.xml file on media root:
           &lt;?xml version="1.0"?>
           <add_on_products xmlns="http://www.suse.com/1.0/yast2ns"
          	xmlns:config="http://www.suse.com/1.0/configns">
          	<product_items config:type="list">
          		<product_item>
          			&lt;!-- Product name visible in UI when offered to user (optional item) -->
          			<name>Add-on Name to Display</name>
          			&lt;!-- Product URL (mandatory item) -->
          			<url>http://product.repository/url/</url>
          			&lt;!-- Product path, default is "/" (optional item) -->
          			<path>/relative/product/path</path>
          			&lt;!--
          				List of products to install from media, by default all products
          				from media are installed (optional item)
          			-->
          			<install_products config:type="list">
          				&lt;!--
          					Product to install - matching the metadata product 'name'
          					(mandatory to fully define 'install_products')
          				-->
          				<product>Product-ID-From-Repository</product>
          				<product>...</product>
          			</install_products>
          			&lt;!--
          				If set to 'true', user is asked whether to install this product,
          				default is 'false' (optional)
          			-->
          			<ask_user config:type="boolean">true</ask_user>
          			&lt;!--
          				Connected to 'ask_user', sets the default status of product,
          				default is 'false' (optional)
          			-->
          			<selected config:type="boolean">true</selected>
          		</product_item>
          		<product_item>
          			...
          		</product_item>
          	</product_items>
           </add_on_products>

          See also:

          • FATE #303675: Support several add-ons on standard medium

          3.3.4. Disintegrate

          Opposite to Integrate()

          Function parameters

          • integer srcid

          Return value

          • void

          3.3.5. DoInstall

          Do installation of the add-on product within an installed system srcid is got via AddOnProduct::src_id

          Return value

          • symbol - the result symbol from wizard sequencer

          3.3.6. Export

          Returns map describing all used add-ons.

          Return value

          • map -

          This is an XML file created from exported map:
           <add-on>
             <add_on_products config:type="list">
               <listentry>
                 <media_url>ftp://server.name/.../</media_url>
                 <product>NEEDS_TO_MATCH_"PRODUCT"_TAG_FROM_content_FILE!</product>
                 <product_dir>/</product_dir>
               </listentry>
               ...
             </add_on_products>
           </add-on>

          3.3.7. GetAbsoluteURL

          Returns an absolute URL from base + relative url. Relative URL needs to start with 'reulrl://' othewise it is not considered being relative and it's returned as it is (just the relative_url parameter).

          Function parameters

          • string base_url

          • string url

          Return value

          • string - absolute_url

          Example 1. 

          
             AddOnProduct::GetAbsoluteURL (
               "http://www.example.org/some%20dir/another%20dir",
               "relurl://../AnotherProduct/"
             ) -> "http://www.example.org/some%20dir/AnotherProduct/"
             AddOnProduct::GetAbsoluteURL (
               "username:password@ftp://www.example.org/dir/",
               "relurl://./Product_CD1/"
             ) -> "username:password@ftp://www.example.org/dir/Product_CD1/"


          3.3.8. Integrate

          Integrate the add-on product to the installation workflow, including preparations for 2nd stage and inst-sys update

          Function parameters

          • integer srcid

          Return value

          • boolean - true on success

          3.3.9. PrepareForRegistration

          Checks whether the content file of the add-on has a flag REGISTERPRODUCT set to "true" or "yes". If it has, product is added into list of pruducts that need registration. Cached content file is used if possible.

          Function parameters

          • integer src_id

          Return value

          • void

          3.3.10. ProcessRegistration

          Returns whether registration is requested by at least one of used Add-On products.

          Return value

          • boolean - if requested

          3.3.11. ReIntegrateFromScratch

          Some product(s) were removed, reintegrating their control files from scratch.

          Return value

          • boolean

          3.3.12. ReadTmpExportFilename

          Reads the Add-Ons configuration stored on disk during the first stage installation.

          Return value

          • boolean

          See also:

          • bugzilla #187558

          3.3.13. RegisterAddOnProduct

          Calls registration client if needed.

          Function parameters

          • integer src_id

          Return value

          • void

          3.3.14. RemoveRegistrationFlag

          Add-On product might have been added into products requesting registration. This pruduct has been removed (during configuring list of add-on products).

          Function parameters

          • integer src_id

          Return value

          • void

          3.3.15. RereadAllSCRAgents

          New add-on product might add also new agents. Functions Rereads all available agents.

          Return value

          • void

          See also:

          • bugzilla #239055, #245508

          3.3.16. SetPreselectedAddOnProductsType

          Sets an add_on_products file type ("plain" or "xml")

          Function parameters

          • string type

          Return value

          • void

          See also:

          • FATE #303675

          3.3.17. TmpExportFilename

          Returns the path where Add-Ons configuration is stored during the fist stage installation. This path reffers to the installed system.

          Return value

          • string

          See also:

          • bugzilla #187558

          3.3.18. UpdateInstSys

          Adapts the inst-sys from the tarball

          Function parameters

          • string filename

          Return value

          • boolean - true on success

          3.4. Global Variables

          3.4.1. add_on_products

          List of all selected repositories

          add_on_products = [
             $[
               "media" : 4, // ID of the source
               "product_dir" : "/",
               "product" : "openSUSE version XX.Y",
               "autoyast_product" : "'PRODUCT' tag for AutoYaST Export",
             ],
             ...
           ]

          3.4.2. last_ret

          return value of last step in the product adding workflow

          3.4.3. src_id

          ID of currently added repository for the add-on product

          3.5. Module Requirements

          3.5.1. Module Imports

          • Directory
          • FileUtils
          • FileUtils
          • Icon
          • InstShowInfo
          • Label
          • Language
          • Mode
          • Mode
          • PackageCallbacks
          • Popup
          • ProductControl
          • ProductFeatures
          • ProductLicense
          • Report
          • Stage
          • String
          • URL
          • Wizard
          • WorkflowManager
          • XML

          3.5.2. Module Includes

            4. Address

            Address manipulation routines

            4.1. Authors

            • Michal Svec <msvec@suse.cz>

            4.2. Summary of Module Globals

            List of Global Functions

            • Check - Check syntax of a network address (IP address or hostname)

            • Check4 - Check syntax of a network address (ip4 or name)

            • Check6 - Check syntax of a network address (ip6 or name)

            • CheckMAC - Check syntax of MAC address

            • Valid4 - Return a description of a valid address (ip4 or name)

            • ValidMAC - Describe a valid MAC address

            List of Global Variables

              4.3. Global Functions

              4.3.1. Check

              Check syntax of a network address (IP address or hostname)

              Function parameters

              • string address

              Return value

              • boolean - true if correct

              4.3.2. Check4

              Check syntax of a network address (ip4 or name)

              Function parameters

              • string address

              Return value

              • boolean - true if correct

              4.3.3. Check6

              Check syntax of a network address (ip6 or name)

              Function parameters

              • string address

              Return value

              • boolean - true if correct

              4.3.4. CheckMAC

              Check syntax of MAC address

              Function parameters

              • string address

              Return value

              • boolean - true if correct

              4.3.5. Valid4

              Return a description of a valid address (ip4 or name)

              Return value

              • string - description

              4.3.6. ValidMAC

              Describe a valid MAC address

              Return value

              • string - description of a valid MAC address

              4.4. Global Variables

              4.5. Module Requirements

              4.5.1. Module Imports

              • Hostname
              • IP

              4.5.2. Module Includes

                5. Answering_machine

                Configuration of a phone answering machine

                5.1. Authors

                • Karsten Keil <kkeil@suse.de>

                5.2. Summary of Module Globals

                List of Global Functions

                • Read - Read config settings

                • Write - Write answering_machine settings and apply changes

                List of Global Variables

                • aconfig - All Answering machine configured user data

                • gconfig - All Answering machine global settings

                • modified - Data was modified?

                • users - List of available users

                5.3. Global Functions

                5.3.1. Read

                Read config settings

                Return value

                • boolean - true if success

                5.3.2. Write

                Write answering_machine settings and apply changes

                Return value

                • boolean - true if success

                5.4. Global Variables

                5.4.1. aconfig

                All Answering machine configured user data

                5.4.2. gconfig

                All Answering machine global settings

                5.4.3. modified

                Data was modified?

                5.4.4. users

                List of available users

                5.5. Module Requirements

                5.5.1. Module Imports

                • Package
                • Users
                • UsersCache

                5.5.2. Module Includes

                  6. AppArmorDialogs

                  6.1. Authors

                    6.2. Summary of Module Globals

                    List of Global Functions

                      List of Global Variables

                        6.3. Global Functions

                        6.4. Global Variables

                        6.5. Module Requirements

                        none

                        7. Arch

                        Architecture, board and bios data

                        7.1. Authors

                        • Klaus Kaempf <kkaempf@suse.de>

                        7.2. Summary of Module Globals

                        List of Global Functions

                        • alpha - true for all alpha architectures

                        • arch_short - Returns general architecture type (one of sparc, mips, ppc, s390, i386, alpha, ia64, x86_64)

                        • architecture - Returns full architecture type (one of i386, sparc, sparc64, mips, mips64, ppc, ppc64, alpha, s390_32, s390_64, ia64, x86_64)

                        • board_chrp - true for all "CHRP" ppc boards

                        • board_iseries - true for all "iSeries" ppc boards

                        • board_mac - true for all PPC "MacRISC" boards

                        • board_mac_new - true for all "NewWorld" PowerMacs

                        • board_mac_old - true for all "OldWorld" powermacs

                        • board_pegasos - true for all "Pegasos" and "Efika" ppc boards

                        • board_prep - true for all "PReP" ppc boards

                        • board_wintel - true for all "Windows/Intel" compliant boards (x86 based)

                        • has_pcmcia - true if the system supports PCMCIA But modern notebook computers do not have it. See also Bugzilla #151813#c10

                        • has_smp - true if running on multiprocessor board. This only reflects the board, not the actual number of CPUs or the running kernel!

                        • i386 - true for all x86 compatible architectures

                        • ia64 - true for all IA64 (itanium) architectures

                        • is_laptop - true if the system runs on laptop

                        • is_uml - true if UML

                        • is_xen - true if Xen kernel is running (dom0 or domU)

                        • is_xen0 - true if dom0 Xen kernel is running

                        • is_xenU - true if domU Xen kernel is running

                        • mips - true for all mips architectures (32 or 64 bit)

                        • mips32 - true for all 32bit mips architectures

                        • mips64 - true for all 64bit mips architectures

                        • ppc - true for all ppc architectures (32 or 64 bit)

                        • ppc32 - true for all 32bit ppc architectures

                        • ppc64 - true for all 64bit ppc architectures

                        • s390 - true for all S/390 architectures (32 or 64 bit)

                        • s390_32 - true for all 32bit S/390 architectures

                        • s390_64 - true for all 64bit S/390 architectures

                        • setSMP - Set "Arch::has_smp ()". Since Alpha doesn't reliably probe smp, 'has_smp' must be set later with this function.

                        • sparc - true for all sparc architectures (32 or 64 bit)

                        • sparc32 - true for all 32bit sparc architectures

                        • sparc64 - true for all 64bit sparc architectures

                        • x11_setup_needed - run X11 configuration after inital boot this is false in case of: installation on iSeries, installation on S390

                        • x86_64 - true for all x86-64 (AMD Hammer) architectures

                        List of Global Variables

                          7.3. Global Functions

                          7.3.1. alpha

                          true for all alpha architectures

                          Return value

                          • boolean

                          7.3.2. arch_short

                          Returns general architecture type (one of sparc, mips, ppc, s390, i386, alpha, ia64, x86_64)

                          Return value

                          • string - arch_short

                          7.3.3. architecture

                          Returns full architecture type (one of i386, sparc, sparc64, mips, mips64, ppc, ppc64, alpha, s390_32, s390_64, ia64, x86_64)

                          Return value

                          • string - architecture

                          7.3.4. board_chrp

                          true for all "CHRP" ppc boards

                          Return value

                          • boolean

                          7.3.5. board_iseries

                          true for all "iSeries" ppc boards

                          Return value

                          • boolean

                          7.3.6. board_mac

                          true for all PPC "MacRISC" boards

                          Return value

                          • boolean

                          7.3.7. board_mac_new

                          true for all "NewWorld" PowerMacs

                          Return value

                          • boolean

                          7.3.8. board_mac_old

                          true for all "OldWorld" powermacs

                          Return value

                          • boolean

                          7.3.9. board_pegasos

                          true for all "Pegasos" and "Efika" ppc boards

                          Return value

                          • boolean

                          7.3.10. board_prep

                          true for all "PReP" ppc boards

                          Return value

                          • boolean

                          7.3.11. board_wintel

                          true for all "Windows/Intel" compliant boards (x86 based)

                          Return value

                          • boolean

                          7.3.12. has_pcmcia

                          true if the system supports PCMCIA But modern notebook computers do not have it. See also Bugzilla #151813#c10

                          Return value

                          • boolean - true if the system supports PCMCIA

                          See also:

                          • is_laptop

                          7.3.13. has_smp

                          true if running on multiprocessor board. This only reflects the board, not the actual number of CPUs or the running kernel!

                          Return value

                          • boolean - true if running on multiprocessor board

                          7.3.14. i386

                          true for all x86 compatible architectures

                          Return value

                          • boolean

                          7.3.15. ia64

                          true for all IA64 (itanium) architectures

                          Return value

                          • boolean

                          7.3.16. is_laptop

                          true if the system runs on laptop

                          Return value

                          • boolean - if the system is a laptop

                          7.3.17. is_uml

                          true if UML

                          Return value

                          • boolean - true if the system is UML

                          7.3.18. is_xen

                          true if Xen kernel is running (dom0 or domU)

                          Return value

                          • boolean - true if the Xen kernel is running

                          7.3.19. is_xen0

                          true if dom0 Xen kernel is running

                          Return value

                          • boolean - true if the Xen kernel is running in dom0

                          See also:

                          • is_xenU

                          • is_xen

                          7.3.20. is_xenU

                          true if domU Xen kernel is running

                          Return value

                          • boolean - true if the Xen kernel is running in another domain than dom0

                          See also:

                          • is_xen0

                          • is_xen

                          7.3.21. mips

                          true for all mips architectures (32 or 64 bit)

                          Return value

                          • boolean

                          See also:

                          • mips32

                          • mips64

                          7.3.22. mips32

                          true for all 32bit mips architectures

                          Return value

                          • boolean

                          See also:

                          • mips

                          • mips64

                          7.3.23. mips64

                          true for all 64bit mips architectures

                          Return value

                          • boolean

                          See also:

                          • mips

                          • mips32

                          7.3.24. ppc

                          true for all ppc architectures (32 or 64 bit)

                          Return value

                          • boolean

                          See also:

                          • ppc32

                          • ppc64

                          7.3.25. ppc32

                          true for all 32bit ppc architectures

                          Return value

                          • boolean

                          See also:

                          • ppc

                          • ppc64

                          7.3.26. ppc64

                          true for all 64bit ppc architectures

                          Return value

                          • boolean

                          See also:

                          • ppc

                          • ppc32

                          7.3.27. s390

                          true for all S/390 architectures (32 or 64 bit)

                          Return value

                          • boolean

                          See also:

                          • s390_32

                          • s390_64

                          7.3.28. s390_32

                          true for all 32bit S/390 architectures

                          Return value

                          • boolean

                          See also:

                          • s390

                          • s390_64

                          7.3.29. s390_64

                          true for all 64bit S/390 architectures

                          Return value

                          • boolean

                          See also:

                          • s390

                          • s390_32

                          7.3.30. setSMP

                          Set "Arch::has_smp ()". Since Alpha doesn't reliably probe smp, 'has_smp' must be set later with this function.

                          Function parameters

                          • boolean is_smp

                          Return value

                          • void

                          Example 2. 

                           setSMP(true);


                          7.3.31. sparc

                          true for all sparc architectures (32 or 64 bit)

                          Return value

                          • boolean

                          See also:

                          • sparc32

                          • sparc64

                          7.3.32. sparc32

                          true for all 32bit sparc architectures

                          Return value

                          • boolean

                          See also:

                          • sparc

                          • sparc64

                          7.3.33. sparc64

                          true for all 64bit sparc architectures

                          Return value

                          • boolean

                          See also:

                          • sparc

                          • sparc32

                          7.3.34. x11_setup_needed

                          run X11 configuration after inital boot this is false in case of: installation on iSeries, installation on S390

                          Return value

                          • boolean - true when the X11 configuration is needed after inital boot

                          See also:

                          • Installation::x11_setup_needed

                          7.3.35. x86_64

                          true for all x86-64 (AMD Hammer) architectures

                          Return value

                          • boolean

                          7.4. Global Variables

                          7.5. Module Requirements

                          none

                          8. AsciiFile

                          8.1. Authors

                          • Thomas Fehr (fehr@suse.de)

                          • Purpose: Handle reading and modifying of ascii files.

                          8.2. Summary of Module Globals

                          List of Global Functions

                          List of Global Variables

                            8.3. Global Functions

                            8.3.1. AppendLine

                            Appends a new line at the bottom

                            Function parameters

                            • map& file

                            • list entry

                            Return value

                            • void

                            8.3.2. ChangeLineField

                            Changes the record in the file defined by row and column

                            Function parameters

                            • map& file

                            • integer line

                            • integer field

                            • string entry

                            Return value

                            • void

                            8.3.3. FindLineField

                            Returns the list of rows where matches searched string in the defined column

                            Function parameters

                            • map file

                            • integer field

                            • string content

                            Return value

                            • list<integer> - matching rows

                            8.3.4. GetLine

                            Returns map of wanted line

                            Function parameters

                            • map& file

                            • integer line

                            Return value

                            • map - of wanted line

                            8.3.5. GetLines

                            Returns map of wanted lines

                            Function parameters

                            • map& file

                            • list<integer> lines

                            Return value

                            • map<integer, map> - with wanted lines

                            8.3.6. NumLines

                            Returns count of lines in file

                            Function parameters

                            • map file

                            Return value

                            • integer - count of lines

                            8.3.7. ReadFile

                            Reads the file from the disk

                            Function parameters

                            • map& file

                            • string pathname

                            Return value

                            • void

                            8.3.8. RemoveLines

                            Removes lines

                            Function parameters

                            • map& file

                            • list<integer> lines

                            Return value

                            • void

                            8.3.9. ReplaceLine

                            Changes a complete line

                            Function parameters

                            • map& file

                            • integer line

                            • list<string> entry

                            Return value

                            • void

                            8.3.10. RewriteFile

                            Writes a content into the file

                            Function parameters

                            • map& file

                            • string fpath

                            Return value

                            • void

                            8.3.11. SetComment

                            Sets the string how the comment starts

                            Function parameters

                            • map& file

                            • string comment

                            Return value

                            • void

                            8.3.12. SetDelimiter

                            Sets the delimiter between the records on one line

                            Function parameters

                            • map& file

                            • string delim

                            Return value

                            • void

                            8.3.13. SetListWidth

                            Sets the widths of records on one line

                            Function parameters

                            • map& file

                            • list widths

                            Return value

                            • void

                            8.4. Global Variables

                            8.5. Module Requirements

                            none

                            9. AuditLaf

                            9.1. Authors

                              9.2. Summary of Module Globals

                              List of Global Functions

                              • Abort - Returns a confirmation popup dialog whether user wants to really abort.

                              • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                              • Export - Dump the auditd settings and the rules to a single map (For use by autoinstallation.)

                              • GetAuditdOption - Get value of given option from SEETINGS

                              • GetRules - Get the current rules

                              • GetRulesFile - Return rules file path

                              • Import - Get all audit settings from the first parameter (For use by autoinstallation.)

                              • Modified - Prototypes

                              • Modified - Data was modified?

                              • Overview - Create an overview table with all configured cards

                              • PollAbort - Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                              • Read - Read all auditd settings

                              • SetAuditdOption - Set option to given value in SETTINGS

                              • SetModified - Mark as modified, for Autoyast.

                              • SetWriteOnly - Set write_only flag (for autoinstalation).

                              • Summary - Create a textual summary and a list of unconfigured cards

                              • Write - Write all auditd settings

                              • WriteOnly -

                              List of Global Variables

                                9.3. Global Functions

                                9.3.1. Abort

                                Returns a confirmation popup dialog whether user wants to really abort.

                                Return value

                                • boolean

                                9.3.2. AutoPackages

                                Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                Return value

                                • map - with 2 lists.

                                9.3.3. Export

                                Dump the auditd settings and the rules to a single map (For use by autoinstallation.)

                                Return value

                                • map - Dumped settings (later acceptable by Import ())

                                9.3.4. GetAuditdOption

                                Get value of given option from SEETINGS

                                Function parameters

                                • string key

                                Return value

                                • string

                                9.3.5. GetRules

                                Get the current rules

                                Return value

                                • string

                                9.3.6. GetRulesFile

                                Return rules file path

                                Return value

                                • string

                                9.3.7. Import

                                Get all audit settings from the first parameter (For use by autoinstallation.)

                                Function parameters

                                • map settings

                                Return value

                                • boolean - True on success

                                9.3.8. Modified

                                Prototypes

                                Return value

                                • boolean

                                9.3.9. Modified

                                Data was modified?

                                Return value

                                • boolean - true if modified

                                9.3.10. Overview

                                Create an overview table with all configured cards

                                Return value

                                • list - table items

                                9.3.11. PollAbort

                                Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                                Return value

                                • boolean - true if abort confirmed

                                9.3.12. Read

                                Read all auditd settings

                                Return value

                                • boolean - true on success

                                9.3.13. SetAuditdOption

                                Set option to given value in SETTINGS

                                Function parameters

                                • string key

                                • string value

                                Return value

                                • boolean

                                9.3.14. SetModified

                                Mark as modified, for Autoyast.

                                Function parameters

                                • boolean value

                                Return value

                                • void

                                9.3.15. SetWriteOnly

                                Set write_only flag (for autoinstalation).

                                Function parameters

                                • boolean value

                                Return value

                                • void

                                9.3.16. Summary

                                Create a textual summary and a list of unconfigured cards

                                Return value

                                • string - summary of the current configuration

                                9.3.17. Write

                                Write all auditd settings

                                Return value

                                • boolean - true on success

                                9.3.18. WriteOnly

                                Return value

                                • boolean - true if module is marked as "write only" (don't start services etc...)

                                9.4. Global Variables

                                9.5. Module Requirements

                                9.5.1. Module Imports

                                • FileUtils
                                • Message
                                • Mode
                                • Popup
                                • Progress
                                • Report
                                • Service
                                • Summary

                                9.5.2. Module Includes

                                  10. AutoInstall

                                  Auto-installation related functions module

                                  10.1. Authors

                                  • Anas Nashif <nashif@suse.de>

                                  10.2. Summary of Module Globals

                                  List of Global Functions

                                  • AutoInstall - Constructer

                                  • Continue - Read saved data in continue mode

                                  • Finish - Finish Auto-Installation by saving misc files

                                  • PXELocalBoot - Put PXE file on the boot server using tftp

                                  • Save - Save configuration

                                  • TurnOff - Turn off the second stage of autoyast

                                  List of Global Variables

                                    10.3. Global Functions

                                    10.3.1. AutoInstall

                                    Constructer

                                    Return value

                                    • void

                                    10.3.2. Continue

                                    Read saved data in continue mode

                                    Return value

                                    • boolean - true on success

                                    10.3.3. Finish

                                    Finish Auto-Installation by saving misc files

                                    Function parameters

                                    • string destdir

                                    Return value

                                    • void

                                    10.3.4. PXELocalBoot

                                    Put PXE file on the boot server using tftp

                                    Return value

                                    • boolean - true on success

                                    10.3.5. Save

                                    Save configuration

                                    Return value

                                    • boolean - true on success

                                    10.3.6. TurnOff

                                    Turn off the second stage of autoyast

                                    Return value

                                    • boolean

                                    10.4. Global Variables

                                    10.5. Module Requirements

                                    10.5.1. Module Imports

                                    • AutoInstallRules
                                    • AutoinstConfig
                                    • Mode
                                    • Profile
                                    • Report
                                    • Stage
                                    • TFTP

                                    10.5.2. Module Includes

                                      11. AutoInstallRules

                                      Process Auto-Installation Rules

                                      11.1. Authors

                                      • Anas Nashif <nashif@suse.de>

                                      11.2. Summary of Module Globals

                                      List of Global Functions

                                      • AutoInstallRules - Constructor

                                      • CreateDefault - Create default rule in case no rules file is available This adds a list of file starting from full hex ip representation to only the first letter. Then default and finally mac address.

                                      • CreateFile - Create default rule in case no rules file is available (Only one file which is given by the user)

                                      • Files - Return list of file to merge (Order matters)

                                      • GetRules - Return list of file to merge (Order matters)

                                      • Init - Initialize

                                      • Merge - Merge Rule results

                                      • ProbeRules - Probe all system data to build a set of rules

                                      • Process - Process Rules

                                      • Read - Read rules file

                                      • StdErrLog - StdErrLog() Dialog for error messages

                                      • XML_cleanup - Cleanup XML file from namespaces put by xslt

                                      • getHostid - Return host id (hex ip )

                                      • getMAC - getMAC() Return MAC address of active device

                                      List of Global Variables

                                        11.3. Global Functions

                                        11.3.1. AutoInstallRules

                                        Constructor

                                        Return value

                                        • void

                                        11.3.2. CreateDefault

                                        Create default rule in case no rules file is available This adds a list of file starting from full hex ip representation to only the first letter. Then default and finally mac address.

                                        Return value

                                        • void

                                        11.3.3. CreateFile

                                        Create default rule in case no rules file is available (Only one file which is given by the user)

                                        Function parameters

                                        • string filename

                                        Return value

                                        • void

                                        11.3.4. Files

                                        Return list of file to merge (Order matters)

                                        Return value

                                        • list<string> - list of files

                                        11.3.5. GetRules

                                        Return list of file to merge (Order matters)

                                        Return value

                                        • boolean

                                        11.3.6. Init

                                        Initialize

                                        Return value

                                        • void

                                        11.3.7. Merge

                                        Merge Rule results

                                        Function parameters

                                        • string result_profile

                                        Return value

                                        • boolean - true on success

                                        11.3.8. ProbeRules

                                        Probe all system data to build a set of rules

                                        Return value

                                        • void

                                        11.3.9. Process

                                        Process Rules

                                        Function parameters

                                        • string result_profile

                                        Return value

                                        • boolean

                                        11.3.10. Read

                                        Read rules file

                                        Return value

                                        • void

                                        11.3.11. StdErrLog

                                        StdErrLog() Dialog for error messages

                                        Function parameters

                                        • string stderr

                                        Return value

                                        • void

                                        11.3.12. XML_cleanup

                                        Cleanup XML file from namespaces put by xslt

                                        Function parameters

                                        • string in

                                        • string out

                                        Return value

                                        • boolean

                                        11.3.13. getHostid

                                        Return host id (hex ip )

                                        Return value

                                        • string - host ID

                                        11.3.14. getMAC

                                        getMAC() Return MAC address of active device

                                        Return value

                                        • string - mac address

                                        11.4. Global Variables

                                        11.5. Module Requirements

                                        11.5.1. Module Imports

                                        • Arch
                                        • AutoinstConfig
                                        • IP
                                        • Installation
                                        • Kernel
                                        • Label
                                        • Mode
                                        • Popup
                                        • Product
                                        • Profile
                                        • Report
                                        • Stage
                                        • Storage
                                        • URL
                                        • XML

                                        11.5.2. Module Includes

                                        • autoinstall/io.ycp

                                        12. AutofsUI

                                        UI-related routines to be run from perl modules (Autofs.pm etc.)

                                        12.1. Authors

                                        • Peter Varkoly <varkoly@novell.com>

                                        12.2. Summary of Module Globals

                                        List of Global Functions

                                          List of Global Variables

                                            12.3. Global Functions

                                            12.4. Global Variables

                                            12.5. Module Requirements

                                            12.5.1. Module Imports

                                            • Label
                                            • Popup

                                            12.5.2. Module Includes

                                            • autofs/helps.ycp

                                            13. AutoinstClass

                                            This module handles the configuration for auto-installation

                                            13.1. Authors

                                            • Anas Nashif <nashif@suse.de>

                                            13.2. Summary of Module Globals

                                            List of Global Functions

                                            List of Global Variables

                                              13.3. Global Functions

                                              13.3.1. Export

                                              Export configuration

                                              Return value

                                              • list<map>

                                              13.3.2. Files

                                              Read files from class directories

                                              Return value

                                              • void

                                              13.3.3. Import

                                              Import configuration

                                              Function parameters

                                              • list<map> settings

                                              Return value

                                              • boolean

                                              13.3.4. MergeClasses

                                              Merge Classes

                                              Function parameters

                                              • map configuration

                                              • string base_profile

                                              • string resultFileName

                                              Return value

                                              • map

                                              13.3.5. Read

                                              Read classes

                                              Return value

                                              • void

                                              13.3.6. Save

                                              Save Class definitions

                                              Return value

                                              • boolean

                                              13.3.7. Summary

                                              Configuration Summary

                                              Return value

                                              • string

                                              13.3.8. findPath

                                              find a profile path

                                              Function parameters

                                              • string name

                                              • string class

                                              Return value

                                              • string - profile Path

                                              13.4. Global Variables

                                              13.5. Module Requirements

                                              13.5.1. Module Imports

                                              • AutoinstConfig
                                              • Summary
                                              • XML

                                              13.5.2. Module Includes

                                              • autoinstall/xml.ycp

                                              14. AutoinstClone

                                              Create a control file from an exisiting machine

                                              14.1. Authors

                                              • Anas Nashif <nashif@suse.de>

                                              14.2. Summary of Module Globals

                                              List of Global Functions

                                              List of Global Variables

                                                14.3. Global Functions

                                                14.3.1. AutoinstClone

                                                Constructor

                                                Return value

                                                • void

                                                14.3.2. Export

                                                Export profile, Used only from within autoyast2

                                                Return value

                                                • void

                                                14.3.3. General

                                                General options

                                                Return value

                                                • map - general options

                                                14.3.4. Process

                                                Build the profile

                                                Return value

                                                • void

                                                14.3.5. Write

                                                Write the profile to a defined path

                                                Function parameters

                                                • string outputFile

                                                Return value

                                                • boolean - true on success

                                                14.3.6. createClonableList

                                                Create a list of clonable resources

                                                Return value

                                                • list - list to be used in widgets

                                                14.4. Global Variables

                                                14.5. Module Requirements

                                                14.5.1. Module Imports

                                                • AutoinstConfig
                                                • Call
                                                • Keyboard
                                                • Language
                                                • Misc
                                                • Mode
                                                • Mode
                                                • Profile
                                                • Profile
                                                • Report
                                                • Storage
                                                • Timezone
                                                • XML
                                                • Y2ModuleConfig

                                                14.5.2. Module Includes

                                                • autoinstall/xml.ycp

                                                15. AutoinstCommon.ycp

                                                Common partitioning functions module

                                                15.1. Authors

                                                • Sven Schober (sschober@suse.de)

                                                15.2. Summary of Module Globals

                                                List of Global Functions

                                                List of Global Variables

                                                  15.3. Global Functions

                                                  15.3.1. isValidField

                                                  Predicates

                                                  Function parameters

                                                  • map<string, any> objectDefinition

                                                  • string field

                                                  Return value

                                                  • boolean

                                                  15.4. Global Variables

                                                  15.5. Module Requirements

                                                  none

                                                  16. AutoinstConfig

                                                  This module handles the configuration for auto-installation

                                                  16.1. Authors

                                                  • Anas Nashif <nashif@suse.de>

                                                  16.2. Summary of Module Globals

                                                  List of Global Functions

                                                  List of Global Variables

                                                    16.3. Global Functions

                                                    16.3.1. AutoinstConfig

                                                    Constructor

                                                    Return value

                                                    • void

                                                    16.3.2. ParseCmdLine

                                                    Return location of profile from command line.

                                                    Function parameters

                                                    • string autoinstall

                                                    Return value

                                                    • boolean - with protocol, server, path

                                                    Example 3. 

                                                     autoyast=http://www.server.com/profiles/


                                                    16.3.3. Save

                                                    Save Configuration global settings

                                                    Return value

                                                    • void

                                                    16.3.4. SetProtocolMessage

                                                    SetProtocolMessage ()

                                                    Return value

                                                    • void

                                                    16.3.5. ShellEscape

                                                    escape a string so it can be passed to a shell

                                                    Function parameters

                                                    • string s

                                                    Return value

                                                    • string - escaped string string

                                                    16.4. Global Variables

                                                    16.5. Module Requirements

                                                    16.5.1. Module Imports

                                                    • Installation
                                                    • Misc
                                                    • Mode
                                                    • URL
                                                    • URL

                                                    16.5.2. Module Includes

                                                    • autoinstall/io.ycp
                                                    • autoinstall/xml.ycp

                                                    17. AutoinstData

                                                    Data storage for Autoinstallation

                                                    17.1. Authors

                                                    • Anas Nashif <nashif@suse.de>

                                                    • Uwe Gansert <ug@suse.de>

                                                    • Lukas Ocilka <locilka@suse.cz>

                                                    17.2. Summary of Module Globals

                                                    List of Global Functions

                                                      List of Global Variables

                                                        17.3. Global Functions

                                                        17.4. Global Variables

                                                        17.5. Module Requirements

                                                        none

                                                        18. AutoinstDrive

                                                        Drive related functions module

                                                        18.1. Authors

                                                        • Sven Schober (sschober@suse.de)

                                                        18.2. Summary of Module Globals

                                                        List of Global Functions

                                                        • getNodeName - Construct node name for display in tree.

                                                        • getNodeReference - Construct reference to drive for use in tree. The references are of the form: "{drive,volgroup}_<id>", e.g. "drive_1", or "volgroup_3"

                                                        • isDrive - Convenience wrappers for more general object predicates

                                                        List of Global Variables

                                                          18.3. Global Functions

                                                          18.3.1. getNodeName

                                                          Construct node name for display in tree.

                                                          Return value

                                                          • string - the newly created node name

                                                          18.3.2. getNodeReference

                                                          Construct reference to drive for use in tree. The references are of the form: "{drive,volgroup}_<id>", e.g. "drive_1", or "volgroup_3"

                                                          Return value

                                                          • string - reference

                                                          18.3.3. isDrive

                                                          Convenience wrappers for more general object predicates

                                                          Return value

                                                          • boolean

                                                          18.4. Global Variables

                                                          18.5. Module Requirements

                                                          18.5.1. Module Imports

                                                          • AutoinstCommon
                                                          • AutoinstPartition

                                                          18.5.2. Module Includes

                                                          • autoinstall/common.ycp
                                                          • autoinstall/tree.ycp
                                                          • autoinstall/types.ycp

                                                          19. AutoinstFile

                                                          Handle complete configuration file dumps

                                                          19.1. Authors

                                                          • Anas Nashif (nashif@suse.de)

                                                          19.2. Summary of Module Globals

                                                          List of Global Functions

                                                          • Export - Export Settings

                                                          • GetModified - Functions which returns if the settings were modified

                                                          • Import - Import Settings

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

                                                          • Summary - Settings Summary

                                                          • Write - Write Settings

                                                          List of Global Variables

                                                            19.3. Global Functions

                                                            19.3.1. Export

                                                            Export Settings

                                                            Return value

                                                            • list<map>

                                                            19.3.2. GetModified

                                                            Functions which returns if the settings were modified

                                                            Return value

                                                            • boolean - settings were modified

                                                            19.3.3. Import

                                                            Import Settings

                                                            Function parameters

                                                            • list<map> settings

                                                            Return value

                                                            • boolean

                                                            19.3.4. SetModified

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

                                                            Return value

                                                            • void

                                                            19.3.5. Summary

                                                            Settings Summary

                                                            Return value

                                                            • string

                                                            19.3.6. Write

                                                            Write Settings

                                                            Return value

                                                            • boolean

                                                            19.4. Global Variables

                                                            19.5. Module Requirements

                                                            19.5.1. Module Imports

                                                            • AutoInstall
                                                            • AutoinstConfig
                                                            • Summary

                                                            19.5.2. Module Includes

                                                            • autoinstall/io.ycp

                                                            20. AutoinstGeneral

                                                            Configuration of general settings for autoyast

                                                            20.1. Authors

                                                            • Anas Nashif (nashif@suse.de)

                                                            20.2. Summary of Module Globals

                                                            List of Global Functions

                                                            List of Global Variables

                                                              20.3. Global Functions

                                                              20.3.1. AutoinstGeneral

                                                              Constructor

                                                              Return value

                                                              • void

                                                              20.3.2. Export

                                                              Export Configuration

                                                              Return value

                                                              • map

                                                              20.3.3. GetModified

                                                              Functions which returns if the settings were modified

                                                              Return value

                                                              • boolean - settings were modified

                                                              20.3.4. Import

                                                              Import Configuration

                                                              Function parameters

                                                              • map settings

                                                              Return value

                                                              • boolean - booelan

                                                              20.3.5. SetModified

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

                                                              Return value

                                                              • void

                                                              20.3.6. SetSignatureHandling

                                                              set the sigature handling

                                                              Return value

                                                              • void

                                                              20.3.7. Summary

                                                              Summary of configuration

                                                              Return value

                                                              • string - Formatted summary

                                                              20.3.8. Write

                                                              Write General Configuration

                                                              Return value

                                                              • boolean - true on success

                                                              20.4. Global Variables

                                                              20.5. Module Requirements

                                                              20.5.1. Module Imports

                                                              • AutoInstall
                                                              • AutoinstConfig
                                                              • AutoinstData
                                                              • Keyboard
                                                              • Keyboard
                                                              • Language
                                                              • Misc
                                                              • Mouse
                                                              • Pkg
                                                              • ProductFeatures
                                                              • Profile
                                                              • Stage
                                                              • Summary
                                                              • Timezone

                                                              20.5.2. Module Includes

                                                                21. AutoinstImage

                                                                Process Auto-Installation Images

                                                                21.1. Authors

                                                                • Uwe Gansert <uwe.gansert@suse.de>

                                                                21.2. Summary of Module Globals

                                                                List of Global Functions

                                                                  List of Global Variables

                                                                    21.3. Global Functions

                                                                    21.4. Global Variables

                                                                    21.5. Module Requirements

                                                                    21.5.1. Module Imports

                                                                    • AutoinstConfig
                                                                    • AutoinstSoftware
                                                                    • Progress
                                                                    • URL

                                                                    21.5.2. Module Includes

                                                                    • autoinstall/io.ycp

                                                                    22. AutoinstLVM

                                                                    LVM

                                                                    22.1. Authors

                                                                    • Anas Nashif <nashif@suse.de>

                                                                    22.2. Summary of Module Globals

                                                                    List of Global Functions

                                                                    • AutoinstLVM - Constructer

                                                                    • Init - Initialize

                                                                    • Write - Write LVM Configuration

                                                                    • get_existing_pvs - Return only those PVs on disks touched by the control file, dont add PVs of unconfigured disks.

                                                                    List of Global Variables

                                                                      22.3. Global Functions

                                                                      22.3.1. AutoinstLVM

                                                                      Constructer

                                                                      Return value

                                                                      • void

                                                                      22.3.2. Init

                                                                      Initialize

                                                                      Return value

                                                                      • boolean

                                                                      22.3.3. Write

                                                                      Write LVM Configuration

                                                                      Return value

                                                                      • boolean - true on success

                                                                      22.3.4. get_existing_pvs

                                                                      Return only those PVs on disks touched by the control file, dont add PVs of unconfigured disks.

                                                                      Function parameters

                                                                      • string vgname

                                                                      Return value

                                                                      • list<map> - existing PVs

                                                                      22.4. Global Variables

                                                                      22.5. Module Requirements

                                                                      22.5.1. Module Imports

                                                                      • AutoinstStorage
                                                                      • FileSystems
                                                                      • Label
                                                                      • Partitions
                                                                      • Report
                                                                      • Storage

                                                                      22.5.2. Module Includes

                                                                      • partitioning/lvm_lib.ycp
                                                                      • partitioning/lvm_lv_lib.ycp
                                                                      • partitioning/lvm_pv_lib.ycp
                                                                      • partitioning/partition_defines.ycp

                                                                      23. AutoinstPartPlan

                                                                      Module representing a partitioning plan

                                                                      23.1. Authors

                                                                      • Sven Schober (sschober@suse.de)

                                                                      23.2. Summary of Module Globals

                                                                      List of Global Functions

                                                                      • Export - Dump the settings to a map, for autoinstallation use.

                                                                      • GetModified - Functions which returns if the settings were modified

                                                                      • Import - Get all the configuration from a map. When called by inst_auto<module name> (preparing autoinstallation data) the list may be empty.

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

                                                                      • Summary - Return summary of configuration

                                                                      • updateTree - Create tree structure from AutoPartPlan

                                                                      List of Global Variables

                                                                        23.3. Global Functions

                                                                        23.3.1. Export

                                                                        Dump the settings to a map, for autoinstallation use.

                                                                        Return value

                                                                        • list<map>

                                                                        23.3.2. GetModified

                                                                        Functions which returns if the settings were modified

                                                                        Return value

                                                                        • boolean - settings were modified

                                                                        23.3.3. Import

                                                                        Get all the configuration from a map. When called by inst_auto<module name> (preparing autoinstallation data) the list may be empty.

                                                                        Function parameters

                                                                        • list<map> settings

                                                                        Return value

                                                                        • boolean - success

                                                                        23.3.4. SetModified

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

                                                                        Return value

                                                                        • void

                                                                        23.3.5. Summary

                                                                        Return summary of configuration

                                                                        Return value

                                                                        • string - configuration summary dialog

                                                                        23.3.6. updateTree

                                                                        Create tree structure from AutoPartPlan

                                                                        Return value

                                                                        • void

                                                                        23.4. Global Variables

                                                                        23.5. Module Requirements

                                                                        23.5.1. Module Imports

                                                                        • AutoinstCommon
                                                                        • AutoinstDrive
                                                                        • AutoinstPartition
                                                                        • Mode
                                                                        • Partitions
                                                                        • Popup
                                                                        • Storage
                                                                        • StorageDevices
                                                                        • Summary

                                                                        23.5.2. Module Includes

                                                                        • autoinstall/common.ycp
                                                                        • autoinstall/tree.ycp
                                                                        • autoinstall/types.ycp

                                                                        24. AutoinstPartition

                                                                        Partition related functions module

                                                                        24.1. Authors

                                                                        • Sven Schober (sschober@suse.de)

                                                                        24.2. Summary of Module Globals

                                                                        List of Global Functions

                                                                        • isPartition - Convenience wrappers for more general object predicates

                                                                        List of Global Variables

                                                                          24.3. Global Functions

                                                                          24.3.1. isPartition

                                                                          Convenience wrappers for more general object predicates

                                                                          Return value

                                                                          • boolean

                                                                          24.4. Global Variables

                                                                          24.5. Module Requirements

                                                                          24.5.1. Module Imports

                                                                          • AutoinstCommon
                                                                          • FileSystems
                                                                          • Partitions

                                                                          24.5.2. Module Includes

                                                                          • autoinstall/common.ycp
                                                                          • autoinstall/tree.ycp
                                                                          • autoinstall/types.ycp

                                                                          25. AutoinstRAID

                                                                          RAID

                                                                          25.1. Authors

                                                                          • Anas Nashif <nashif@suse.de>

                                                                          25.2. Summary of Module Globals

                                                                          List of Global Functions

                                                                          List of Global Variables

                                                                            25.3. Global Functions

                                                                            25.3.1. AutoinstRAID

                                                                            Constructor

                                                                            Return value

                                                                            • void

                                                                            25.3.2. ExistingMDs

                                                                            Return existing MDs

                                                                            Function parameters

                                                                            • string md

                                                                            Return value

                                                                            • list - list of existing MDs

                                                                            25.3.3. Init

                                                                            Initialize

                                                                            Return value

                                                                            • boolean

                                                                            25.3.4. Write

                                                                            Create RAID Configuration

                                                                            Return value

                                                                            • boolean

                                                                            25.4. Global Variables

                                                                            25.5. Module Requirements

                                                                            25.5.1. Module Imports

                                                                            • AutoinstStorage
                                                                            • Partitions
                                                                            • Storage

                                                                            25.5.2. Module Includes

                                                                            • partitioning/partition_defines.ycp
                                                                            • partitioning/raid_lib.ycp

                                                                            26. AutoinstScripts

                                                                            Custom scripts

                                                                            26.1. Authors

                                                                            • Anas Nashif <nashif@suse.de>

                                                                            26.2. Summary of Module Globals

                                                                            List of Global Functions

                                                                            • AddEditScript - Add or edit a script

                                                                            • Export - Dump the settings to a map, for autoinstallation use.

                                                                            • GetModified - Functions which returns if the settings were modified

                                                                            • Import - Get all the configuration from a map. When called by autoinst_<module name> (preparing autoinstallation data) the map may be empty.

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

                                                                            • Summary - Return Summary

                                                                            • Write - Execute pre scripts

                                                                            • deleteScript - delete a script from a list

                                                                            • typeString - return type of script as formatted string

                                                                            List of Global Variables

                                                                              26.3. Global Functions

                                                                              26.3.1. AddEditScript

                                                                              Add or edit a script

                                                                              Function parameters

                                                                              • string scriptName

                                                                              • string source

                                                                              • string interpreter

                                                                              • string type

                                                                              • boolean chrooted

                                                                              • boolean debug

                                                                              • boolean feedback

                                                                              • boolean network

                                                                              Return value

                                                                              • void

                                                                              26.3.2. Export

                                                                              Dump the settings to a map, for autoinstallation use.

                                                                              Return value

                                                                              • map<string, list>

                                                                              26.3.3. GetModified

                                                                              Functions which returns if the settings were modified

                                                                              Return value

                                                                              • boolean - settings were modified

                                                                              26.3.4. Import

                                                                              Get all the configuration from a map. When called by autoinst_<module name> (preparing autoinstallation data) the map may be empty.

                                                                              Function parameters

                                                                              • map s

                                                                              Return value

                                                                              • boolean - success

                                                                              26.3.5. SetModified

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

                                                                              Return value

                                                                              • void

                                                                              26.3.6. Summary

                                                                              Return Summary

                                                                              Return value

                                                                              • string - summary

                                                                              26.3.7. Write

                                                                              Execute pre scripts

                                                                              Function parameters

                                                                              • string type

                                                                              • boolean special

                                                                              Return value

                                                                              • boolean - true on success

                                                                              26.3.8. deleteScript

                                                                              delete a script from a list

                                                                              Function parameters

                                                                              • string scriptName

                                                                              Return value

                                                                              • void

                                                                              26.3.9. typeString

                                                                              return type of script as formatted string

                                                                              Function parameters

                                                                              • string type

                                                                              Return value

                                                                              • string - type as translated string

                                                                              26.4. Global Variables

                                                                              26.5. Module Requirements

                                                                              26.5.1. Module Imports

                                                                              • AutoinstConfig
                                                                              • Label
                                                                              • Mode
                                                                              • Popup
                                                                              • Service
                                                                              • Summary
                                                                              • URL

                                                                              26.5.2. Module Includes

                                                                              • autoinstall/io.ycp

                                                                              27. AutoinstSoftware

                                                                              Software

                                                                              27.1. Authors

                                                                              • Anas Nashif <nashif@suse.de>

                                                                              27.2. Summary of Module Globals

                                                                              List of Global Functions

                                                                              List of Global Variables

                                                                                27.3. Global Functions

                                                                                27.3.1. AddModulePackages

                                                                                Add packages needed by modules, i.e. NIS, NFS etc.

                                                                                Function parameters

                                                                                • list<string> module_packages

                                                                                Return value

                                                                                • void

                                                                                27.3.2. AutoinstSoftware

                                                                                Constructer

                                                                                Return value

                                                                                • void

                                                                                27.3.3. Export

                                                                                Export data

                                                                                Return value

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

                                                                                27.3.4. GetModified

                                                                                Functions which returns if the settings were modified

                                                                                Return value

                                                                                • boolean - settings were modified

                                                                                27.3.5. Import

                                                                                Import data

                                                                                Function parameters

                                                                                • map settings

                                                                                Return value

                                                                                • boolean - true on success

                                                                                27.3.6. ReadHelper

                                                                                Return list of software packages of calling client

                                                                                Return value

                                                                                • map<string, any > - map of installed software package "patterns" -> list<string> addon selections "packages" -> list<string> user selected packages "remove-packages" -> list<string> packages to remove

                                                                                27.3.7. RemoveModulePackages

                                                                                Remove packages not needed by modules, i.e. NIS, NFS etc.

                                                                                Function parameters

                                                                                • list<string> module_packages

                                                                                Return value

                                                                                • void

                                                                                27.3.8. SetModified

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

                                                                                Return value

                                                                                • void

                                                                                27.3.9. Summary

                                                                                Summary

                                                                                Return value

                                                                                • string - Html formatted configuration summary

                                                                                27.3.10. Write

                                                                                Configure software settings

                                                                                Return value

                                                                                • boolean

                                                                                27.3.11. addPostPackages

                                                                                Add post packages

                                                                                Function parameters

                                                                                • list<string> calcpost

                                                                                Return value

                                                                                • void

                                                                                27.3.12. autoinstPackages

                                                                                Compute list of packages selected by user and other packages needed for important configuration modules.

                                                                                Return value

                                                                                • list<string> - of strings list of packages needed for autoinstallation

                                                                                27.3.13. pmInit

                                                                                Initialize temporary target

                                                                                Return value

                                                                                • void

                                                                                27.4. Global Variables

                                                                                27.5. Module Requirements

                                                                                27.5.1. Module Imports

                                                                                • AutoinstConfig
                                                                                • AutoinstData
                                                                                • Kernel
                                                                                • Mode
                                                                                • PackageAI
                                                                                • Packages
                                                                                • Popup
                                                                                • ProductControl
                                                                                • Profile
                                                                                • Report
                                                                                • SpaceCalculation
                                                                                • Stage
                                                                                • Storage
                                                                                • Summary

                                                                                27.5.2. Module Includes

                                                                                  28. AutoinstStorage

                                                                                  Storage

                                                                                  28.1. Authors

                                                                                  • Anas Nashif <nashif@suse.de>

                                                                                  28.2. Summary of Module Globals

                                                                                  List of Global Functions

                                                                                  • GetModified - Functions which returns if the settings were modified

                                                                                  • Import - Get all the configuration from a map. When called by inst_auto<module name> (preparing autoinstallation data) the list may be empty.

                                                                                  • ImportAdvanced - Import Fstab data

                                                                                  • Overview - Partitioning Overview

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

                                                                                  • Summary - return Summary of configuration

                                                                                  • Write - Create partition plan

                                                                                  • mountBy - if mountby is used, we will search for the matching partition here.

                                                                                  List of Global Variables

                                                                                    28.3. Global Functions

                                                                                    28.3.1. GetModified

                                                                                    Functions which returns if the settings were modified

                                                                                    Return value

                                                                                    • boolean - settings were modified

                                                                                    28.3.2. Import

                                                                                    Get all the configuration from a map. When called by inst_auto<module name> (preparing autoinstallation data) the list may be empty.

                                                                                    Function parameters

                                                                                    • list<map> settings

                                                                                    Return value

                                                                                    • boolean - success

                                                                                    28.3.3. ImportAdvanced

                                                                                    Import Fstab data

                                                                                    Function parameters

                                                                                    • map settings

                                                                                    Return value

                                                                                    • boolean - true on success

                                                                                    28.3.4. Overview

                                                                                    Partitioning Overview

                                                                                    Return value

                                                                                    • list - Overview

                                                                                    28.3.5. SetModified

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

                                                                                    Return value

                                                                                    • void

                                                                                    28.3.6. Summary

                                                                                    return Summary of configuration

                                                                                    Return value

                                                                                    • string - configuration summary dialog

                                                                                    28.3.7. Write

                                                                                    Create partition plan

                                                                                    Return value

                                                                                    • boolean

                                                                                    28.3.8. mountBy

                                                                                    if mountby is used, we will search for the matching partition here.

                                                                                    Function parameters

                                                                                    • list<map> settings

                                                                                    Return value

                                                                                    • list<map>

                                                                                    28.4. Global Variables

                                                                                    28.5. Module Requirements

                                                                                    28.5.1. Module Imports

                                                                                    • AutoinstData
                                                                                    • FileSystems
                                                                                    • Partitions
                                                                                    • Partitions
                                                                                    • Popup
                                                                                    • Report
                                                                                    • RootPart
                                                                                    • Storage
                                                                                    • Storage
                                                                                    • Summary

                                                                                    28.5.2. Module Includes

                                                                                    • autoinstall/autoinst_dialogs.ycp
                                                                                    • autoinstall/autopart.ycp
                                                                                    • partitioning/partition_defines.ycp

                                                                                    29. AutoinstX11

                                                                                    X11

                                                                                    29.1. Authors

                                                                                    • Marcus Schäfer <ms@suse.de>

                                                                                    29.2. Summary of Module Globals

                                                                                    List of Global Functions

                                                                                      List of Global Variables

                                                                                        29.3. Global Functions

                                                                                        29.4. Global Variables

                                                                                        29.5. Module Requirements

                                                                                        29.5.1. Module Imports

                                                                                        • Arch
                                                                                        • Directory
                                                                                        • Mode
                                                                                        • Summary
                                                                                        • XLib

                                                                                        29.5.2. Module Includes

                                                                                          30. Autologin

                                                                                          Autologin read/write routines

                                                                                          30.1. Authors

                                                                                          • Jiri Suchomel <jsuchome@suse.cz>

                                                                                          30.2. Summary of Module Globals

                                                                                          List of Global Functions

                                                                                          • AskForDisabling - Ask if autologin should be disabled (and disable it in such case)

                                                                                          • Disable - Disable autologin

                                                                                          • DisableAndWrite - Disable autologin and write it (used probably for automatic disabling without asking)

                                                                                          • Read - Read autologin settings

                                                                                          • Use - Wrapper for setting the 'used' variable

                                                                                          • Write - Write autologin settings

                                                                                          List of Global Variables

                                                                                          • available - Is autologin feature available?

                                                                                          • modified - Autologin settings modified?

                                                                                          • pw_less - Login without passwords?

                                                                                          • used - Is autogion used? Usualy true when user is not empty, but for the first time (during installation), this can be true by default although user is "" (depends on the control file)

                                                                                          • user - User to log in automaticaly

                                                                                          30.3. Global Functions

                                                                                          30.3.1. AskForDisabling

                                                                                          Ask if autologin should be disabled (and disable it in such case)

                                                                                          Function parameters

                                                                                          • string new

                                                                                          Return value

                                                                                          • boolean - Is autologin used?

                                                                                          30.3.2. Disable

                                                                                          Disable autologin

                                                                                          Return value

                                                                                          • void

                                                                                          30.3.3. DisableAndWrite

                                                                                          Disable autologin and write it (used probably for automatic disabling without asking)

                                                                                          Function parameters

                                                                                          • boolean write_only

                                                                                          Return value

                                                                                          • boolean - written anything?

                                                                                          30.3.4. Read

                                                                                          Read autologin settings

                                                                                          Return value

                                                                                          • boolean - used?

                                                                                          30.3.5. Use

                                                                                          Wrapper for setting the 'used' variable

                                                                                          Function parameters

                                                                                          • boolean use

                                                                                          Return value

                                                                                          • void

                                                                                          30.3.6. Write

                                                                                          Write autologin settings

                                                                                          Function parameters

                                                                                          • boolean write_only

                                                                                          Return value

                                                                                          • boolean - written anything?

                                                                                          30.4. Global Variables

                                                                                          30.4.1. available

                                                                                          Is autologin feature available?

                                                                                          30.4.2. modified

                                                                                          Autologin settings modified?

                                                                                          30.4.3. pw_less

                                                                                          Login without passwords?

                                                                                          30.4.4. used

                                                                                          Is autogion used? Usualy true when user is not empty, but for the first time (during installation), this can be true by default although user is "" (depends on the control file)

                                                                                          30.4.5. user

                                                                                          User to log in automaticaly

                                                                                          30.5. Module Requirements

                                                                                          30.5.1. Module Imports

                                                                                          • Package
                                                                                          • Popup
                                                                                          • ProductFeatures

                                                                                          30.5.2. Module Includes

                                                                                            31. BootArch

                                                                                            Module containing specific data for differnt architecturese (as some architectures support multiple bootloaders, some bootloaders support multiple architectures)

                                                                                            31.1. Authors

                                                                                            • Jiri Srain <jsrain@suse.cz>

                                                                                            • Olaf Dabrunz <od@suse.de>

                                                                                            31.2. Summary of Module Globals

                                                                                            List of Global Functions

                                                                                            List of Global Variables

                                                                                              31.3. Global Functions

                                                                                              31.3.1. DefaultKernelParams

                                                                                              Get parameters for the default kernel

                                                                                              Function parameters

                                                                                              • string resume

                                                                                              Return value

                                                                                              • string - parameters for default kernel

                                                                                              31.3.2. FailsafeKernelParams

                                                                                              Get parameters for the failsafe kernel

                                                                                              Return value

                                                                                              • string - parameters for failsafe kernel

                                                                                              31.3.3. InitrdImage

                                                                                              Get the file holding the initd imahe

                                                                                              Return value

                                                                                              • string - the initrd image

                                                                                              31.3.4. ResumeAvailable

                                                                                              Is Suspend to Disk available?

                                                                                              Return value

                                                                                              • boolean - true if STD is available

                                                                                              31.3.5. VgaAvailable

                                                                                              Is VGA parameter setting available

                                                                                              Return value

                                                                                              • boolean - true if vga= can be set

                                                                                              31.4. Global Variables

                                                                                              31.5. Module Requirements

                                                                                              31.5.1. Module Imports

                                                                                              • Arch
                                                                                              • Kernel
                                                                                              • Linuxrc
                                                                                              • ProductFeatures
                                                                                              • Stage
                                                                                              • StorageControllers

                                                                                              31.5.2. Module Includes

                                                                                                32. BootCommon

                                                                                                Data to be shared between common and bootloader-specific parts of bootloader configurator/installator, generic versions of bootloader specific functions

                                                                                                32.1. Authors

                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                • Joachim Plack <jplack@suse.de>

                                                                                                • Olaf Dabrunz <od@suse.de>

                                                                                                32.2. Summary of Module Globals

                                                                                                List of Global Functions

                                                                                                • CreateLinuxSection - Create section for linux kernel

                                                                                                • Dom0MemorySize - Get the size of memory for XEN's domain 0

                                                                                                • Export - Export bootloader settings to a map

                                                                                                • Import - Import settings from a map

                                                                                                • Propose - Propose bootloader settings

                                                                                                • Read - Read settings from disk

                                                                                                • Reset - Reset bootloader settings

                                                                                                • Save - Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                • Section2Index - Search for section passed

                                                                                                • Summary - Display bootloader summary

                                                                                                • Update - Update read settings to new version of configuration files

                                                                                                • Write - Write bootloader settings to disk

                                                                                                • XenPresent - Check whether XEN is selected for installation resp. selected

                                                                                                • getBootloaders - List bootloaders available for configured architecture

                                                                                                • getLoaderType - Get currently used bootloader, detect if not set yet

                                                                                                • isTrustedGrub - Function check if trusted grub is selected or installed return true if is selected/installed and add trusted_grub to globals

                                                                                                • setCurrentLoaderAttribs - Set attributes of specified bootloader to variable containing attributes of currently used bootloader, call its initializer

                                                                                                • setLoaderType - set type of bootloader

                                                                                                List of Global Variables

                                                                                                • BootPartitionDevice - string sepresenting device name of /boot partition same as RootPartitionDevice if no separate /boot partition

                                                                                                • ExtendedPartitionDevice - string representing device name of extended partition

                                                                                                • RootPartitionDevice - string representing device name of / partition

                                                                                                • activate - Activate bootloader partition during installation?

                                                                                                • activate_changed - Was the activate flag changed by user?

                                                                                                • backup_mbr - Backup original MBR before installing bootloader

                                                                                                • bois_id_missing - Flag indicates that bios_id_missing in disk true if missing false if at least one disk has bios_id

                                                                                                • bootloader_attribs - Parameters of all bootloaders

                                                                                                • bootloaders - List of all supported bootloaders

                                                                                                • cached_settings_base_data_change_time - Saved change time from target map - proposal

                                                                                                • changed - were settings changed (== true)

                                                                                                • current_bootloader_attribs - Parameters of currently used bootloader

                                                                                                • current_section - Curtrently edited section -- tmp store

                                                                                                • current_section_index - Index of current section, -1 for new created section

                                                                                                • current_section_name - Name of currently edited section

                                                                                                • default_changed - true if default section is edited it is important for remember default name...

                                                                                                • del_parts - List of partitions deleted in primary proposal

                                                                                                • device_mapping - device mapping between Linux and firmware

                                                                                                • exports - map of other exported information for new perl-Bootloader interface

                                                                                                • files_edited - Were configuration files manually edited and chamged?

                                                                                                • files_edited_warned - Has been files edited warning already shown?

                                                                                                • floppy_devices - list of installed floppy devices

                                                                                                • global_options - map of global options and types for new perl-Bootloader interface

                                                                                                • globals - map of global options and values

                                                                                                • kernelCmdLine - Kernel parameters at previous detection

                                                                                                • loader_device - device to save loader stage 1 to NOTE: this variable is being phased out. The boot_* keys in the globals map are now used to remember the selected boot location. Thus, we now have a list of selected loader devices. It can be generated from the information in the boot_* keys and the global variables (Boot|Root|Extended)PartitionDevice and mbrDisk by calling GetBootloaderDevices().

                                                                                                • location_changed - Was bootloader location changed? (== true)

                                                                                                • mbrDisk - device holding MBR for bootloader

                                                                                                • multipath_mapping - device mapping between real devices and multipath

                                                                                                • one_section_changed - was currently edited section changed (== true)

                                                                                                • opt_types - Option types for different bootloaders

                                                                                                • other_bl - Settings of other bootloaders used when switching bootloader

                                                                                                • partitioning_last_change - time of last change of partitioning

                                                                                                • prefer_lilo - Last detection proposed to prefer lilo instead of grub

                                                                                                • read_default_section_name - The name of the default section as it was read

                                                                                                • removed_sections - true if memtest was removed by user (manually) during the installation proposal

                                                                                                • repl_mbr - Replace MBR with generic code after bootloader installation?

                                                                                                • save_all - Save everything, not only changed settings

                                                                                                • save_on_finish - Shall be settings saved when finishing bootloader configuration?

                                                                                                • section_options - map of section options and types for new perl-Bootloader interface

                                                                                                • sections - list of section

                                                                                                • sections_changed - were sections settings changes (== true)

                                                                                                • selected_location - The kind of bootloader location that the user selected last time he went to the dialog. Used as a hint next time a proposal is requested, so the proposal can try to satisfy the user's previous preference. NOTE: this variable is being phased out. The boot_* keys in the globals map will be used to remember the last selected location. Currently, valid values are: mbr, boot, root, floppy, mbr_md, none

                                                                                                • verbose - Show verbose summary output

                                                                                                • was_proposed - was the propose function called (== true)

                                                                                                • was_read - Were module settings read (== true)

                                                                                                • write_settings - map of save mode settings

                                                                                                32.3. Global Functions

                                                                                                32.3.1. CreateLinuxSection

                                                                                                Create section for linux kernel

                                                                                                Function parameters

                                                                                                • string title

                                                                                                Return value

                                                                                                • map<string,any> - a map describing the section

                                                                                                32.3.2. Dom0MemorySize

                                                                                                Get the size of memory for XEN's domain 0

                                                                                                Return value

                                                                                                • integer - the memory size in kB

                                                                                                32.3.3. Export

                                                                                                Export bootloader settings to a map

                                                                                                Return value

                                                                                                • map - bootloader settings

                                                                                                32.3.4. Import

                                                                                                Import settings from a map

                                                                                                Function parameters

                                                                                                • map settings

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                32.3.5. Propose

                                                                                                Propose bootloader settings

                                                                                                Return value

                                                                                                • void

                                                                                                32.3.6. Read

                                                                                                Read settings from disk

                                                                                                Function parameters

                                                                                                • boolean reread

                                                                                                • boolean avoid_reading_device_map

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                32.3.7. Reset

                                                                                                Reset bootloader settings

                                                                                                Function parameters

                                                                                                • boolean init

                                                                                                Return value

                                                                                                • void

                                                                                                32.3.8. Save

                                                                                                Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                Function parameters

                                                                                                • boolean clean

                                                                                                • boolean init

                                                                                                • boolean flush

                                                                                                Return value

                                                                                                • boolean - true if success

                                                                                                32.3.9. Section2Index

                                                                                                Search for section passed

                                                                                                Function parameters

                                                                                                • string section_name

                                                                                                Return value

                                                                                                • integer - index number

                                                                                                32.3.10. Summary

                                                                                                Display bootloader summary

                                                                                                Return value

                                                                                                • list<string> - a list of summary lines

                                                                                                32.3.11. Update

                                                                                                Update read settings to new version of configuration files

                                                                                                Return value

                                                                                                • void

                                                                                                32.3.12. Write

                                                                                                Write bootloader settings to disk

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                32.3.13. XenPresent

                                                                                                Check whether XEN is selected for installation resp. selected

                                                                                                Return value

                                                                                                • boolean - true of XEN installed/selected

                                                                                                32.3.14. getBootloaders

                                                                                                List bootloaders available for configured architecture

                                                                                                Return value

                                                                                                • list<string> - a list of bootloaders

                                                                                                32.3.15. getLoaderType

                                                                                                Get currently used bootloader, detect if not set yet

                                                                                                Function parameters

                                                                                                • boolean recheck

                                                                                                Return value

                                                                                                • string - botloader type

                                                                                                32.3.16. isTrustedGrub

                                                                                                Function check if trusted grub is selected or installed return true if is selected/installed and add trusted_grub to globals

                                                                                                Return value

                                                                                                • boolean - true if trusted grub is selected/installed

                                                                                                32.3.17. setCurrentLoaderAttribs

                                                                                                Set attributes of specified bootloader to variable containing attributes of currently used bootloader, call its initializer

                                                                                                Function parameters

                                                                                                • string loader_type

                                                                                                Return value

                                                                                                • void

                                                                                                32.3.18. setLoaderType

                                                                                                set type of bootloader

                                                                                                Function parameters

                                                                                                • string bootloader

                                                                                                Return value

                                                                                                • void

                                                                                                32.4. Global Variables

                                                                                                32.4.1. BootPartitionDevice

                                                                                                string sepresenting device name of /boot partition same as RootPartitionDevice if no separate /boot partition

                                                                                                32.4.2. ExtendedPartitionDevice

                                                                                                string representing device name of extended partition

                                                                                                32.4.3. RootPartitionDevice

                                                                                                string representing device name of / partition

                                                                                                32.4.4. activate

                                                                                                Activate bootloader partition during installation?

                                                                                                32.4.5. activate_changed

                                                                                                Was the activate flag changed by user?

                                                                                                32.4.6. backup_mbr

                                                                                                Backup original MBR before installing bootloader

                                                                                                32.4.7. bois_id_missing

                                                                                                Flag indicates that bios_id_missing in disk true if missing false if at least one disk has bios_id

                                                                                                32.4.8. bootloader_attribs

                                                                                                Parameters of all bootloaders

                                                                                                32.4.9. bootloaders

                                                                                                List of all supported bootloaders

                                                                                                32.4.10. cached_settings_base_data_change_time

                                                                                                Saved change time from target map - proposal

                                                                                                32.4.11. changed

                                                                                                were settings changed (== true)

                                                                                                32.4.12. current_bootloader_attribs

                                                                                                Parameters of currently used bootloader

                                                                                                32.4.13. current_section

                                                                                                Curtrently edited section -- tmp store

                                                                                                32.4.14. current_section_index

                                                                                                Index of current section, -1 for new created section

                                                                                                32.4.15. current_section_name

                                                                                                Name of currently edited section

                                                                                                32.4.16. default_changed

                                                                                                true if default section is edited it is important for remember default name...

                                                                                                32.4.17. del_parts

                                                                                                List of partitions deleted in primary proposal

                                                                                                32.4.18. device_mapping

                                                                                                device mapping between Linux and firmware

                                                                                                32.4.19. exports

                                                                                                map of other exported information for new perl-Bootloader interface

                                                                                                32.4.20. files_edited

                                                                                                Were configuration files manually edited and chamged?

                                                                                                32.4.21. files_edited_warned

                                                                                                Has been files edited warning already shown?

                                                                                                32.4.22. floppy_devices

                                                                                                list of installed floppy devices

                                                                                                32.4.23. global_options

                                                                                                map of global options and types for new perl-Bootloader interface

                                                                                                32.4.24. globals

                                                                                                map of global options and values

                                                                                                32.4.25. kernelCmdLine

                                                                                                Kernel parameters at previous detection

                                                                                                32.4.26. loader_device

                                                                                                device to save loader stage 1 to NOTE: this variable is being phased out. The boot_* keys in the globals map are now used to remember the selected boot location. Thus, we now have a list of selected loader devices. It can be generated from the information in the boot_* keys and the global variables (Boot|Root|Extended)PartitionDevice and mbrDisk by calling GetBootloaderDevices().

                                                                                                32.4.27. location_changed

                                                                                                Was bootloader location changed? (== true)

                                                                                                32.4.28. mbrDisk

                                                                                                device holding MBR for bootloader

                                                                                                32.4.29. multipath_mapping

                                                                                                device mapping between real devices and multipath

                                                                                                32.4.30. one_section_changed

                                                                                                was currently edited section changed (== true)

                                                                                                32.4.31. opt_types

                                                                                                Option types for different bootloaders

                                                                                                32.4.32. other_bl

                                                                                                Settings of other bootloaders used when switching bootloader

                                                                                                32.4.33. partitioning_last_change

                                                                                                time of last change of partitioning

                                                                                                32.4.34. prefer_lilo

                                                                                                Last detection proposed to prefer lilo instead of grub

                                                                                                32.4.35. read_default_section_name

                                                                                                The name of the default section as it was read

                                                                                                32.4.36. removed_sections

                                                                                                true if memtest was removed by user (manually) during the installation proposal

                                                                                                32.4.37. repl_mbr

                                                                                                Replace MBR with generic code after bootloader installation?

                                                                                                32.4.38. save_all

                                                                                                Save everything, not only changed settings

                                                                                                32.4.39. save_on_finish

                                                                                                Shall be settings saved when finishing bootloader configuration?

                                                                                                32.4.40. section_options

                                                                                                map of section options and types for new perl-Bootloader interface

                                                                                                32.4.41. sections

                                                                                                list of section

                                                                                                32.4.42. sections_changed

                                                                                                were sections settings changes (== true)

                                                                                                32.4.43. selected_location

                                                                                                The kind of bootloader location that the user selected last time he went to the dialog. Used as a hint next time a proposal is requested, so the proposal can try to satisfy the user's previous preference. NOTE: this variable is being phased out. The boot_* keys in the globals map will be used to remember the last selected location. Currently, valid values are: mbr, boot, root, floppy, mbr_md, none

                                                                                                32.4.44. verbose

                                                                                                Show verbose summary output

                                                                                                32.4.45. was_proposed

                                                                                                was the propose function called (== true)

                                                                                                32.4.46. was_read

                                                                                                Were module settings read (== true)

                                                                                                32.4.47. write_settings

                                                                                                map of save mode settings

                                                                                                32.5. Module Requirements

                                                                                                32.5.1. Module Imports

                                                                                                • Arch
                                                                                                • GfxMenu
                                                                                                • HTML
                                                                                                • Linuxrc
                                                                                                • Mode
                                                                                                • Package
                                                                                                • PackageSystem
                                                                                                • PackagesProposal
                                                                                                • Pkg
                                                                                                • Popup
                                                                                                • Storage
                                                                                                • String

                                                                                                32.5.2. Module Includes

                                                                                                • bootloader/generic/helps.ycp
                                                                                                • bootloader/routines/lib_iface.ycp
                                                                                                • bootloader/routines/lilolike.ycp
                                                                                                • bootloader/routines/misc.ycp
                                                                                                • bootloader/routines/popups.ycp

                                                                                                33. BootELILO

                                                                                                Module containing specific functions for ELILO configuration and installation

                                                                                                33.1. Authors

                                                                                                • Joachim Plack <jplack@suse.de>

                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                • Andreas Schwab <schwab@suse.de>

                                                                                                • Olaf Dabrunz <od@suse.de>

                                                                                                • Philipp Thomas <pth@suse.de>

                                                                                                33.2. Summary of Module Globals

                                                                                                List of Global Functions

                                                                                                List of Global Variables

                                                                                                33.3. Global Functions

                                                                                                33.3.1. BootELILO

                                                                                                Constructor

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.2. CreateGlobals

                                                                                                Propose global options of bootloader modifies internal structures

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.3. CreateSections

                                                                                                Propose sections to bootloader menu modifies internal structures

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.4. Export

                                                                                                Export bootloader settings to a map

                                                                                                Return value

                                                                                                • map - bootloader settings

                                                                                                33.3.5. FlagBootDefaultOnce

                                                                                                Set section to boot on next reboot.

                                                                                                Function parameters

                                                                                                • string section

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                33.3.6. GetFunctions

                                                                                                Return map of provided functions

                                                                                                Return value

                                                                                                • map<string, any> - a map of functions (eg. $["write"::Write])

                                                                                                33.3.7. Import

                                                                                                Import settings from a map

                                                                                                Function parameters

                                                                                                • map settings

                                                                                                Return value

                                                                                                • boolean

                                                                                                33.3.8. Initializer

                                                                                                Initializer of ELILO bootloader

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.9. Propose

                                                                                                Propose bootloader settings

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.10. Read

                                                                                                Read settings from disk

                                                                                                Function parameters

                                                                                                • boolean reread

                                                                                                • boolean avoid_reading_device_map

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                33.3.11. Reset

                                                                                                Reset bootloader settings

                                                                                                Function parameters

                                                                                                • boolean init

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.12. Save

                                                                                                Save all bootloader configuration files

                                                                                                Function parameters

                                                                                                • boolean clean

                                                                                                • boolean init

                                                                                                • boolean flush

                                                                                                Return value

                                                                                                • boolean - true if success

                                                                                                33.3.13. Summary

                                                                                                Display bootloader summary

                                                                                                Return value

                                                                                                • list<string> - a list of summary lines

                                                                                                33.3.14. Update

                                                                                                Update read settings to new version of configuration files

                                                                                                Return value

                                                                                                • void

                                                                                                33.3.15. Write

                                                                                                Write bootloader settings to disk

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                33.3.16. getEfiMountPoint

                                                                                                Return mountpoint of partition holding EFI data

                                                                                                Return value

                                                                                                • string - mountpoint if partition holding EFI data

                                                                                                33.3.17. getEliloConfFilename

                                                                                                Return path to elilo.conf file

                                                                                                Return value

                                                                                                • string - path to elilo.conf

                                                                                                33.3.18. getEliloConfSubdir

                                                                                                Get directory containing elilo.conf relative to EFI partition's root

                                                                                                Return value

                                                                                                • string - directory containing elilo.conf relative to EFI root

                                                                                                33.3.19. getEliloConfSubpath

                                                                                                Get path of elilo.conf relative to EFI partition's root

                                                                                                Return value

                                                                                                • string - path of elilo.conf relative to EFI partition's root

                                                                                                33.4. Global Variables

                                                                                                33.4.1. create_efi_entry

                                                                                                True if EFI entry should be recreated

                                                                                                33.4.2. elilo_conf_filename

                                                                                                elilo.conf path

                                                                                                33.4.3. old_efi_entry

                                                                                                Name of EFI entry when read settings

                                                                                                33.5. Module Requirements

                                                                                                33.5.1. Module Imports

                                                                                                • Arch
                                                                                                • BootArch
                                                                                                • BootCommon
                                                                                                • Installation
                                                                                                • Kernel
                                                                                                • Mode
                                                                                                • Product
                                                                                                • Product
                                                                                                • Report
                                                                                                • Stage
                                                                                                • Storage
                                                                                                • String

                                                                                                33.5.2. Module Includes

                                                                                                • bootloader/elilo/helps.ycp
                                                                                                • bootloader/generic/dialogs.ycp
                                                                                                • bootloader/routines/popups.ycp

                                                                                                34. BootGRUB

                                                                                                Module containing specific functions for GRUB configuration and installation

                                                                                                34.1. Authors

                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                • Joachim Plack <jplack@suse.de>

                                                                                                • Olaf Dabrunz <od@suse.de>

                                                                                                • Philipp Thomas <pth@suse.de>

                                                                                                34.2. Summary of Module Globals

                                                                                                List of Global Functions

                                                                                                • BootGRUB - Constructor

                                                                                                • CheckAdditionalKernels - Check for additional kernels which could go to the proposed settings

                                                                                                • CreateSections - Propose sections to bootloader menu modifies internal structures

                                                                                                • FlagOnetimeBoot - Boot passed section once on next reboot.

                                                                                                • GetFunctions - Return map of provided functions

                                                                                                • Initializer - Initializer of GRUB bootloader

                                                                                                • Propose - Propose bootloader settings

                                                                                                • Read - Read settings from disk

                                                                                                • Reset - Reset bootloader settings

                                                                                                • Save - Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                • StandardGlobals - Propose global options of bootloader

                                                                                                • Summary - Display bootloader summary

                                                                                                • Update - Update read settings to new version of configuration files

                                                                                                • Write - Write bootloader settings to disk

                                                                                                List of Global Variables

                                                                                                34.3. Global Functions

                                                                                                34.3.1. BootGRUB

                                                                                                Constructor

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.2. CheckAdditionalKernels

                                                                                                Check for additional kernels which could go to the proposed settings

                                                                                                Return value

                                                                                                • list<map<string,string> > - a list of kernels to propose

                                                                                                34.3.3. CreateSections

                                                                                                Propose sections to bootloader menu modifies internal structures

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.4. FlagOnetimeBoot

                                                                                                Boot passed section once on next reboot.

                                                                                                Function parameters

                                                                                                • string section

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                34.3.5. GetFunctions

                                                                                                Return map of provided functions

                                                                                                Return value

                                                                                                • map<string, any> - a map of functions (eg. $["write"::Write])

                                                                                                34.3.6. Initializer

                                                                                                Initializer of GRUB bootloader

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.7. Propose

                                                                                                Propose bootloader settings

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.8. Read

                                                                                                Read settings from disk

                                                                                                Function parameters

                                                                                                • boolean reread

                                                                                                • boolean avoid_reading_device_map

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                34.3.9. Reset

                                                                                                Reset bootloader settings

                                                                                                Function parameters

                                                                                                • boolean init

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.10. Save

                                                                                                Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                Function parameters

                                                                                                • boolean clean

                                                                                                • boolean init

                                                                                                • boolean flush

                                                                                                Return value

                                                                                                • boolean - true if success

                                                                                                34.3.11. StandardGlobals

                                                                                                Propose global options of bootloader

                                                                                                Return value

                                                                                                • map<string,string>

                                                                                                34.3.12. Summary

                                                                                                Display bootloader summary

                                                                                                Return value

                                                                                                • list<string> - a list of summary lines

                                                                                                34.3.13. Update

                                                                                                Update read settings to new version of configuration files

                                                                                                Return value

                                                                                                • void

                                                                                                34.3.14. Write

                                                                                                Write bootloader settings to disk

                                                                                                Return value

                                                                                                • boolean - true on success

                                                                                                34.4. Global Variables

                                                                                                34.4.1. disks_order

                                                                                                Disks order for ordering widget purproses

                                                                                                34.4.2. insert_saved_mbr

                                                                                                Insert saved MBR to bootloader menu?

                                                                                                34.4.3. merge_level

                                                                                                Shall proposal merge menus?

                                                                                                34.5. Module Requirements

                                                                                                34.5.1. Module Imports

                                                                                                • Arch
                                                                                                • BootCommon
                                                                                                • HTML
                                                                                                • Kernel
                                                                                                • Mode
                                                                                                • Pkg
                                                                                                • Stage
                                                                                                • Storage
                                                                                                • StorageDevices

                                                                                                34.5.2. Module Includes

                                                                                                • bootloader/generic/device_map_edit_widget.ycp
                                                                                                • bootloader/generic/dialogs.ycp
                                                                                                • bootloader/grub/helps.ycp
                                                                                                • bootloader/grub/misc.ycp
                                                                                                • bootloader/grub/trusted_grub_edit.ycp
                                                                                                • bootloader/routines/popups.ycp

                                                                                                35. BootLILO

                                                                                                Module containing specific functions for LILO configuration and installation

                                                                                                35.1. Authors

                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                • Olaf Dabrunz <od@suse.de>

                                                                                                • Philipp Thomas <pth@suse.de>

                                                                                                35.2. Summary of Module Globals

                                                                                                List of Global Functions

                                                                                                • BootLILO - Constructor

                                                                                                • CreateGlobals - Propose global options of bootloader modifies internal structures

                                                                                                • CreateSections - Propose sections to bootloader menu modifies internal sreuctures

                                                                                                • FlagOnetimeBoot - Set section to boot on next reboot

                                                                                                • GetFunctions - Return map of provided functions

                                                                                                • Initializer - Initializer of LILO bootloader

                                                                                                • Propose - Propose bootloader settings

                                                                                                • Read - Read settings from disk

                                                                                                • Save - Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                • Update - Update read settings to new version of configuration files

                                                                                                • Write - Write bootloader settings to disk

                                                                                                List of Global Variables

                                                                                                  35.3. Global Functions

                                                                                                  35.3.1. BootLILO

                                                                                                  Constructor

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.2. CreateGlobals

                                                                                                  Propose global options of bootloader modifies internal structures

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.3. CreateSections

                                                                                                  Propose sections to bootloader menu modifies internal sreuctures

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.4. FlagOnetimeBoot

                                                                                                  Set section to boot on next reboot

                                                                                                  Function parameters

                                                                                                  • string section

                                                                                                  Return value

                                                                                                  • boolean - true on success

                                                                                                  35.3.5. GetFunctions

                                                                                                  Return map of provided functions

                                                                                                  Return value

                                                                                                  • map<string, any> - a map of functions (eg. $["write":BootLILO::Write])

                                                                                                  35.3.6. Initializer

                                                                                                  Initializer of LILO bootloader

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.7. Propose

                                                                                                  Propose bootloader settings

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.8. Read

                                                                                                  Read settings from disk

                                                                                                  Function parameters

                                                                                                  • boolean reread

                                                                                                  • boolean avoid_reading_device_map

                                                                                                  Return value

                                                                                                  • boolean - true on success

                                                                                                  35.3.9. Save

                                                                                                  Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                  Function parameters

                                                                                                  • boolean clean

                                                                                                  • boolean init

                                                                                                  • boolean flush

                                                                                                  Return value

                                                                                                  • boolean - true if success

                                                                                                  35.3.10. Update

                                                                                                  Update read settings to new version of configuration files

                                                                                                  Return value

                                                                                                  • void

                                                                                                  35.3.11. Write

                                                                                                  Write bootloader settings to disk

                                                                                                  Return value

                                                                                                  • boolean - true on success

                                                                                                  35.4. Global Variables

                                                                                                  35.5. Module Requirements

                                                                                                  35.5.1. Module Imports

                                                                                                  • Arch
                                                                                                  • BootCommon
                                                                                                  • Kernel
                                                                                                  • Mode
                                                                                                  • Pkg
                                                                                                  • Storage

                                                                                                  35.5.2. Module Includes

                                                                                                  • bootloader/generic/dialogs.ycp
                                                                                                  • bootloader/routines/dialogs_i386.ycp
                                                                                                  • bootloader/routines/popups.ycp

                                                                                                  36. BootPOWERLILO

                                                                                                  Module containing specific functions for POWERLILO configuration and installation

                                                                                                  36.1. Authors

                                                                                                  • Jiri Srain <jsrain@suse.cz>

                                                                                                  • Joachim Plack <jplack@suse.de>

                                                                                                  • Olaf Dabrunz <od@suse.de>

                                                                                                  • Philipp Thomas <pth@suse.de>

                                                                                                  36.2. Summary of Module Globals

                                                                                                  List of Global Functions

                                                                                                  • BootPOWERLILO - Constructor

                                                                                                  • CreateGlobals - Propose global options of bootloader modifies internal structures

                                                                                                  • CreateSections - Propose sections to bootloader menu modifies internal sreuctures

                                                                                                  • Export - Export bootloader settings to a map

                                                                                                  • FlagOnetimeBoot - Set section to boot on next reboot

                                                                                                  • GetFunctions - Return map of provided functions

                                                                                                  • Import - Import settings from a map

                                                                                                  • Initializer - Initializer of PowerLILO bootloader

                                                                                                  • LocationProposal - Propose the location of the root device on disk and the boot device (if any), according to the subarchitecture. Results are stored in global variables.

                                                                                                  • Propose - Propose bootloader settings

                                                                                                  • Read - Read settings from disk

                                                                                                  • Reset - Reset bootloader settings

                                                                                                  • Save - Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                  • SaveInstSourceId - Save the ID of the base installation source modifies internal variable

                                                                                                  • Summary - Display bootloader summary

                                                                                                  • Update - Update read settings to new version of configuration files

                                                                                                  • Write - Write bootloader settings to disk

                                                                                                  • currentBoardInit - Initialize the attribute of currently used board type

                                                                                                  • iSeriesInit - Initialize attributes of the board type

                                                                                                  • iSeriesWrite - Install the board-type-specific part of bootloader

                                                                                                  List of Global Variables

                                                                                                    36.3. Global Functions

                                                                                                    36.3.1. BootPOWERLILO

                                                                                                    Constructor

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.2. CreateGlobals

                                                                                                    Propose global options of bootloader modifies internal structures

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.3. CreateSections

                                                                                                    Propose sections to bootloader menu modifies internal sreuctures

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.4. Export

                                                                                                    Export bootloader settings to a map

                                                                                                    Return value

                                                                                                    • map - bootloader settings

                                                                                                    36.3.5. FlagOnetimeBoot

                                                                                                    Set section to boot on next reboot

                                                                                                    Function parameters

                                                                                                    • string section

                                                                                                    Return value

                                                                                                    • boolean - true on success

                                                                                                    36.3.6. GetFunctions

                                                                                                    Return map of provided functions

                                                                                                    Return value

                                                                                                    • map<string, any> - map of functions (eg. $["write":BootPOWERLILO::Write])

                                                                                                    36.3.7. Import

                                                                                                    Import settings from a map

                                                                                                    Function parameters

                                                                                                    • map settings

                                                                                                    Return value

                                                                                                    • boolean - true on success

                                                                                                    36.3.8. Initializer

                                                                                                    Initializer of PowerLILO bootloader

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.9. LocationProposal

                                                                                                    Propose the location of the root device on disk and the boot device (if any), according to the subarchitecture. Results are stored in global variables.

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.10. Propose

                                                                                                    Propose bootloader settings

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.11. Read

                                                                                                    Read settings from disk

                                                                                                    Function parameters

                                                                                                    • boolean reread

                                                                                                    • boolean avoid_reading_device_map

                                                                                                    Return value

                                                                                                    • boolean - true on success

                                                                                                    36.3.12. Reset

                                                                                                    Reset bootloader settings

                                                                                                    Function parameters

                                                                                                    • boolean init

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.13. Save

                                                                                                    Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                    Function parameters

                                                                                                    • boolean clean

                                                                                                    • boolean init

                                                                                                    • boolean flush

                                                                                                    Return value

                                                                                                    • boolean - true if success

                                                                                                    36.3.14. SaveInstSourceId

                                                                                                    Save the ID of the base installation source modifies internal variable

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.15. Summary

                                                                                                    Display bootloader summary

                                                                                                    Return value

                                                                                                    • list<string> - a list of summary lines

                                                                                                    36.3.16. Update

                                                                                                    Update read settings to new version of configuration files

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.17. Write

                                                                                                    Write bootloader settings to disk

                                                                                                    Return value

                                                                                                    • boolean - true on success

                                                                                                    36.3.18. currentBoardInit

                                                                                                    Initialize the attribute of currently used board type

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.19. iSeriesInit

                                                                                                    Initialize attributes of the board type

                                                                                                    Return value

                                                                                                    • void

                                                                                                    36.3.20. iSeriesWrite

                                                                                                    Install the board-type-specific part of bootloader

                                                                                                    Return value

                                                                                                    • boolean - true on success

                                                                                                    36.4. Global Variables

                                                                                                    36.5. Module Requirements

                                                                                                    36.5.1. Module Imports

                                                                                                    • Arch
                                                                                                    • BootArch
                                                                                                    • BootCommon
                                                                                                    • Installation
                                                                                                    • Kernel
                                                                                                    • Mode
                                                                                                    • Pkg
                                                                                                    • Stage
                                                                                                    • Storage

                                                                                                    36.5.2. Module Includes

                                                                                                    • bootloader/generic/dialogs.ycp
                                                                                                    • bootloader/ppc/helps.ycp
                                                                                                    • bootloader/routines/popups.ycp

                                                                                                    37. BootSupportCheck

                                                                                                    Check whether the current system setup is a supported configuration

                                                                                                    37.1. Authors

                                                                                                    • Jiri Srain <jsrain@suse.cz>

                                                                                                    37.2. Summary of Module Globals

                                                                                                    List of Global Functions

                                                                                                    • DetectedProblems - List detected problems Always run SystemSupported before calling this function

                                                                                                    • GRUB - GRUB-related check

                                                                                                    • StringProblems - Formated string of detected problems Always run SystemSupported before calling this function

                                                                                                    • SystemSupported - Check if the system configuraiton is supported Also sets the founds problems into internal variable Always run this function before calling DetectedProblems()

                                                                                                    • check_BootDevice - Check if boot partition exist check if not on raid0

                                                                                                    List of Global Variables

                                                                                                      37.3. Global Functions

                                                                                                      37.3.1. DetectedProblems

                                                                                                      List detected problems Always run SystemSupported before calling this function

                                                                                                      Return value

                                                                                                      • list<string> - a list of problems, empty if no was found

                                                                                                      37.3.2. GRUB

                                                                                                      GRUB-related check

                                                                                                      Return value

                                                                                                      • boolean

                                                                                                      37.3.3. StringProblems

                                                                                                      Formated string of detected problems Always run SystemSupported before calling this function

                                                                                                      Return value

                                                                                                      • string - a list of problems, empty if no was found

                                                                                                      37.3.4. SystemSupported

                                                                                                      Check if the system configuraiton is supported Also sets the founds problems into internal variable Always run this function before calling DetectedProblems()

                                                                                                      Return value

                                                                                                      • boolean - true if supported

                                                                                                      37.3.5. check_BootDevice

                                                                                                      Check if boot partition exist check if not on raid0

                                                                                                      Return value

                                                                                                      • boolean - true on success

                                                                                                      37.4. Global Variables

                                                                                                      37.5. Module Requirements

                                                                                                      37.5.1. Module Imports

                                                                                                      • Arch
                                                                                                      • BootCommon
                                                                                                      • Bootloader
                                                                                                      • Storage

                                                                                                      37.5.2. Module Includes

                                                                                                        38. BootZIPL

                                                                                                        Module containing specific functions for ZIPL configuration and installation

                                                                                                        38.1. Authors

                                                                                                        • Joachim Plack <jplack@suse.de>

                                                                                                        • Jiri Srain <jsrain@suse.cz>

                                                                                                        • Philipp Thomas <pth@suse.de>

                                                                                                        38.2. Summary of Module Globals

                                                                                                        List of Global Functions

                                                                                                        • BootZIPL - Constructor

                                                                                                        • FlagOnetimeBoot - Set section to boot on next reboot.

                                                                                                        • GetFunctions - Return map of provided functions

                                                                                                        • Initializer - Initializer of S390 bootloader

                                                                                                        • Propose - Propose bootloader settings

                                                                                                        • Read - Read settings from disk

                                                                                                        • Save - Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                        • Summary - Display bootloader summary

                                                                                                        • Update - Update read settings to new version of configuration files

                                                                                                        • Write - Write bootloader settings to disk

                                                                                                        • updateHardwareConfig - Update /etc/sysconfig/hardware configuration Use data from install.inf file

                                                                                                        List of Global Variables

                                                                                                          38.3. Global Functions

                                                                                                          38.3.1. BootZIPL

                                                                                                          Constructor

                                                                                                          Return value

                                                                                                          • void

                                                                                                          38.3.2. FlagOnetimeBoot

                                                                                                          Set section to boot on next reboot.

                                                                                                          Function parameters

                                                                                                          • string section

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          38.3.3. GetFunctions

                                                                                                          Return map of provided functions

                                                                                                          Return value

                                                                                                          • map<string, any> - a map of functions (eg. $["write"::Write])

                                                                                                          38.3.4. Initializer

                                                                                                          Initializer of S390 bootloader

                                                                                                          Return value

                                                                                                          • void

                                                                                                          38.3.5. Propose

                                                                                                          Propose bootloader settings

                                                                                                          Return value

                                                                                                          • void

                                                                                                          38.3.6. Read

                                                                                                          Read settings from disk

                                                                                                          Function parameters

                                                                                                          • boolean reread

                                                                                                          • boolean avoid_reading_device_map

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          38.3.7. Save

                                                                                                          Save all bootloader configuration files to the cache of the PlugLib PlugLib must be initialized properly !!!

                                                                                                          Function parameters

                                                                                                          • boolean clean

                                                                                                          • boolean init

                                                                                                          • boolean flush

                                                                                                          Return value

                                                                                                          • boolean - true if success

                                                                                                          38.3.8. Summary

                                                                                                          Display bootloader summary

                                                                                                          Return value

                                                                                                          • list<string> - a list of summary lines

                                                                                                          38.3.9. Update

                                                                                                          Update read settings to new version of configuration files

                                                                                                          Return value

                                                                                                          • void

                                                                                                          38.3.10. Write

                                                                                                          Write bootloader settings to disk

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          38.3.11. updateHardwareConfig

                                                                                                          Update /etc/sysconfig/hardware configuration Use data from install.inf file

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          38.4. Global Variables

                                                                                                          38.5. Module Requirements

                                                                                                          38.5.1. Module Imports

                                                                                                          • BootArch
                                                                                                          • BootCommon
                                                                                                          • Installation
                                                                                                          • Kernel
                                                                                                          • Mode
                                                                                                          • Stage

                                                                                                          38.5.2. Module Includes

                                                                                                          • bootloader/generic/dialogs.ycp
                                                                                                          • bootloader/routines/popups.ycp
                                                                                                          • bootloader/zipl/helps.ycp

                                                                                                          39. Bootloader

                                                                                                          Bootloader installation and configuration base module

                                                                                                          39.1. Authors

                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                          • Olaf Dabrunz <od@suse.de>

                                                                                                          39.2. Summary of Module Globals

                                                                                                          List of Global Functions

                                                                                                          List of Global Variables

                                                                                                          39.3. Global Functions

                                                                                                          39.3.1. Bootloader

                                                                                                          Constructor

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.2. DelDuplicatedSections

                                                                                                          Delete duplicated boot sections from BootCommon::sections

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.3. Export

                                                                                                          Export bootloader settings to a map

                                                                                                          Return value

                                                                                                          • map - bootloader settings

                                                                                                          39.3.4. FlagOnetimeBoot

                                                                                                          Set section to boot on next reboot

                                                                                                          Function parameters

                                                                                                          • string section

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.5. Import

                                                                                                          Import settings from a map

                                                                                                          Function parameters

                                                                                                          • map settings

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.6. PreUpdate

                                                                                                          Process update actions needed before packages update starts

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.7. Propose

                                                                                                          Propose bootloader settings

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.8. Read

                                                                                                          Read settings from disk

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.9. ReadOrProposeIfNeeded

                                                                                                          Check whether settings were read or proposed, if not, decide what to do and read or propose settings

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.10. Reset

                                                                                                          Reset bootloader settings

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.11. ResetEx

                                                                                                          Reset bootloader settings

                                                                                                          Function parameters

                                                                                                          • boolean init

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.12. ResolveSymlink

                                                                                                          Resolve a single symlink in key image_key in section map s

                                                                                                          Function parameters

                                                                                                          • map<string,any> section

                                                                                                          • string key

                                                                                                          Return value

                                                                                                          • map<string,any> - section map of the changed section

                                                                                                          39.3.13. RunDelayedUpdates

                                                                                                          Set section to boot on next reboot

                                                                                                          Return value

                                                                                                          • void - true on success

                                                                                                          39.3.14. SetWriteMode

                                                                                                          Set settings how to write bootloader

                                                                                                          Function parameters

                                                                                                          • map<string,any> settings

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.15. Summary

                                                                                                          Display bootloader summary

                                                                                                          Return value

                                                                                                          • list<string> - a list of summary lines

                                                                                                          39.3.16. Update

                                                                                                          Update the whole configuration

                                                                                                          Function parameters

                                                                                                          • map<string,any> iv

                                                                                                          • map<string,any> uv

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.17. UpdateConfiguration

                                                                                                          Update read settings to new version of configuration files

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.18. UpdateGfxMenu

                                                                                                          Update the language of GFX menu according to currently selected language

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.19. Write

                                                                                                          Write bootloader settings to disk

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.20. WriteInstallation

                                                                                                          Write bootloader settings during installation

                                                                                                          Return value

                                                                                                          • boolean - true on success

                                                                                                          39.3.21. getBootDevice

                                                                                                          Get device containing /boot directory

                                                                                                          Return value

                                                                                                          • string - boot device

                                                                                                          39.3.22. getDefaultSection

                                                                                                          return default section label

                                                                                                          Return value

                                                                                                          • string - default section label

                                                                                                          39.3.23. getKernelParam

                                                                                                          get kernel parameters from bootloader configuration file

                                                                                                          Function parameters

                                                                                                          • string section

                                                                                                          • string key

                                                                                                          Return value

                                                                                                          • string - value, "false" if not present, "true" if present key without value

                                                                                                          39.3.24. getLoaderType

                                                                                                          Get currently used bootloader, detect if not set yet

                                                                                                          Return value

                                                                                                          • string - botloader type

                                                                                                          39.3.25. getProposedDefaultSection

                                                                                                          Get default section as proposed during installation

                                                                                                          Return value

                                                                                                          • string - section that was proposed as default during installation, if not known, return current default section if it is of type "image", if not found return first linux section, if no present, return empty string

                                                                                                          39.3.26. getRootDevice

                                                                                                          Get root fs device

                                                                                                          Return value

                                                                                                          • string - root device

                                                                                                          39.3.27. getSectionsList

                                                                                                          Get list of bootloader sections

                                                                                                          Function parameters

                                                                                                          • symbol type

                                                                                                          Return value

                                                                                                          • list - of strings representing sections names

                                                                                                          39.3.28. listKernelParams

                                                                                                          List kernel parameters

                                                                                                          Function parameters

                                                                                                          • string section

                                                                                                          Return value

                                                                                                          • list<string> - a list of kernel parameters (in the form 'hdd=ide-scsi')

                                                                                                          39.3.29. setBootDevice

                                                                                                          Set device containing /boot directory

                                                                                                          Function parameters

                                                                                                          • string device

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.30. setLoaderType

                                                                                                          Set type of bootloader Just a wrapper to BootCommon::setLoaderType

                                                                                                          Function parameters

                                                                                                          • string bootloader

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.3.31. setRootDevice

                                                                                                          Set root fs device

                                                                                                          Function parameters

                                                                                                          • string device

                                                                                                          Return value

                                                                                                          • void

                                                                                                          39.4. Global Variables

                                                                                                          39.4.1. cached_proposal

                                                                                                          Cache for the installation proposal

                                                                                                          39.4.2. proposed_cfg_changed

                                                                                                          Configuration was changed during inst. proposal if true

                                                                                                          39.4.3. repeating_write

                                                                                                          Write is repeating again Because of progress bar during inst_finish

                                                                                                          39.5. Module Requirements

                                                                                                          39.5.1. Module Imports

                                                                                                          • Arch
                                                                                                          • Arch
                                                                                                          • BootCommon
                                                                                                          • BootELILO
                                                                                                          • BootGRUB
                                                                                                          • BootLILO
                                                                                                          • BootPOWERLILO
                                                                                                          • Directory
                                                                                                          • Initrd
                                                                                                          • Installation
                                                                                                          • Kernel
                                                                                                          • Mode
                                                                                                          • ProductFeatures
                                                                                                          • Progress
                                                                                                          • Stage
                                                                                                          • Storage

                                                                                                          39.5.2. Module Includes

                                                                                                          • bootloader/routines/popups.ycp
                                                                                                          • bootloader/routines/switcher.ycp

                                                                                                          40. CWM

                                                                                                          Routines for common widget manipulation

                                                                                                          40.1. Authors

                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                          40.2. Summary of Module Globals

                                                                                                          List of Global Functions

                                                                                                          • AdjustButtons - Adjust the labels of the bottom buttons of the wizard sequencer

                                                                                                          • CreateWidgets - Read widgets with listed names

                                                                                                          • DisableButtons - Disable given bottom buttons of the wizard sequencer

                                                                                                          • GetProcessedWidget - Return description map of currently processed widget

                                                                                                          • InitNull - Do-nothing replacement for a widget initialization function. Used for push buttons if all the other widgets have a fallback.

                                                                                                          • MergeHelps - Merge helps from the widgets

                                                                                                          • OkCancelBox - Create a term with OK and Cancel buttons placed horizontally

                                                                                                          • PrepareDialog - Prepare the dialog, replace strings in the term with appropriate widgets

                                                                                                          • ReplaceWidgetHelp - Replace help for a particular widget

                                                                                                          • Run - Generic function to create dialog and handle it's events

                                                                                                          • SetValidationFailedHandler - Set handler to be called after validation of a dialog failed

                                                                                                          • ShowAndRun - Display the dialog and run its event loop

                                                                                                          • ShowAndRunOrig - Display the dialog and run its event loop

                                                                                                          • StoreNull - Do-nothing replacement for a widget storing function. Used for push buttons if all the other widgets have a fallback.

                                                                                                          • StringsOfTerm - Process term with the dialog, return all strings. To be used as an argument for widget_names until they are obsoleted.

                                                                                                          • ValidateBasicType - Validate the value against the basic type

                                                                                                          • ValidateMaps - Validate widget description map, check for maps structure Also checks option description maps if present

                                                                                                          • ValidateValueType - Validate type of entry of the widget/option description map Also checks option description maps if present

                                                                                                          • cleanupWidgets - Cleanup after dialog was finished (independently on what event) global only because of testsuites

                                                                                                          • handleWidgets - Handle change of widget after event generated global only because of testsuites

                                                                                                          • initWidgets - Set widgets according to internally stored settings global only because of testsuites

                                                                                                          • mergeFunctions - Add fallback functions to a widget global only because of testsuites

                                                                                                          • prepareWidget - Prepare a widget for usage

                                                                                                          • saveWidgets - Save changes of widget after event generated global only because of testsuites CWMTab uses it too

                                                                                                          • validateWidget - Validate single widget

                                                                                                          • validateWidgets - Validate dialog contents for allow it to be saved

                                                                                                          List of Global Variables

                                                                                                            40.3. Global Functions

                                                                                                            40.3.1. AdjustButtons

                                                                                                            Adjust the labels of the bottom buttons of the wizard sequencer

                                                                                                            Function parameters

                                                                                                            • string next

                                                                                                            • string back

                                                                                                            • string abort

                                                                                                            • string help

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.2. CreateWidgets

                                                                                                            Read widgets with listed names

                                                                                                            Function parameters

                                                                                                            • list<string> names

                                                                                                            • map<string,map<string,any> > source

                                                                                                            Return value

                                                                                                            • list<map<string, any> > - of maps representing widgets

                                                                                                            40.3.3. DisableButtons

                                                                                                            Disable given bottom buttons of the wizard sequencer

                                                                                                            Function parameters

                                                                                                            • list<string> buttons

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.4. GetProcessedWidget

                                                                                                            Return description map of currently processed widget

                                                                                                            Return value

                                                                                                            • map<string, any> - description map of currently processed widget

                                                                                                            40.3.5. InitNull

                                                                                                            Do-nothing replacement for a widget initialization function. Used for push buttons if all the other widgets have a fallback.

                                                                                                            Function parameters

                                                                                                            • string key

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.6. MergeHelps

                                                                                                            Merge helps from the widgets

                                                                                                            Function parameters

                                                                                                            • list<map<string,any> > widgets

                                                                                                            Return value

                                                                                                            • string - merged helps of the widgets

                                                                                                            40.3.7. OkCancelBox

                                                                                                            Create a term with OK and Cancel buttons placed horizontally

                                                                                                            Return value

                                                                                                            • term - the term (HBox)

                                                                                                            40.3.8. PrepareDialog

                                                                                                            Prepare the dialog, replace strings in the term with appropriate widgets

                                                                                                            Function parameters

                                                                                                            • term dialog

                                                                                                            • list<map<string,any> > widgets

                                                                                                            Return value

                                                                                                            • term - updated term ready to be used as a dialog

                                                                                                            40.3.9. ReplaceWidgetHelp

                                                                                                            Replace help for a particular widget

                                                                                                            Function parameters

                                                                                                            • string widget

                                                                                                            • string help

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.10. Run

                                                                                                            Generic function to create dialog and handle it's events

                                                                                                            Function parameters

                                                                                                            • list<map<string, any> > widgets

                                                                                                            • map<any, any> functions

                                                                                                            Return value

                                                                                                            • symbol - wizard sequencer symbol

                                                                                                            40.3.11. SetValidationFailedHandler

                                                                                                            Set handler to be called after validation of a dialog failed

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.12. ShowAndRun

                                                                                                            Display the dialog and run its event loop

                                                                                                            Function parameters

                                                                                                            • map<string,any> settings

                                                                                                            Return value

                                                                                                            • symbol

                                                                                                            40.3.13. ShowAndRunOrig

                                                                                                            Display the dialog and run its event loop

                                                                                                            Function parameters

                                                                                                            • list<string> widget_names

                                                                                                            • map<string,map<string,any> > widget_descr

                                                                                                            • term contents

                                                                                                            • string caption

                                                                                                            • string back_button

                                                                                                            • string next_button

                                                                                                            • map<any, any> fallback

                                                                                                            Return value

                                                                                                            • symbol - wizard sequencer symbol

                                                                                                            40.3.14. StoreNull

                                                                                                            Do-nothing replacement for a widget storing function. Used for push buttons if all the other widgets have a fallback.

                                                                                                            Function parameters

                                                                                                            • string key

                                                                                                            • map event

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.15. StringsOfTerm

                                                                                                            Process term with the dialog, return all strings. To be used as an argument for widget_names until they are obsoleted.

                                                                                                            Function parameters

                                                                                                            • term t

                                                                                                            Return value

                                                                                                            • list<string> - strings found in the term

                                                                                                            40.3.16. ValidateBasicType

                                                                                                            Validate the value against the basic type

                                                                                                            Function parameters

                                                                                                            • any value

                                                                                                            • string type

                                                                                                            Return value

                                                                                                            • boolean - true on success or if do not know how to validate

                                                                                                            40.3.17. ValidateMaps

                                                                                                            Validate widget description map, check for maps structure Also checks option description maps if present

                                                                                                            Function parameters

                                                                                                            • map<string,map<string,any> > widgets

                                                                                                            Return value

                                                                                                            • boolean - true on success

                                                                                                            40.3.18. ValidateValueType

                                                                                                            Validate type of entry of the widget/option description map Also checks option description maps if present

                                                                                                            Function parameters

                                                                                                            • string key

                                                                                                            • any value

                                                                                                            • string widget

                                                                                                            Return value

                                                                                                            • boolean - true if validation succeeded

                                                                                                            40.3.19. cleanupWidgets

                                                                                                            Cleanup after dialog was finished (independently on what event) global only because of testsuites

                                                                                                            Function parameters

                                                                                                            • list<map<string,any> > widgets

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.20. handleWidgets

                                                                                                            Handle change of widget after event generated global only because of testsuites

                                                                                                            Function parameters

                                                                                                            • list<map <string, any> > widgets

                                                                                                            • map event_descr

                                                                                                            Return value

                                                                                                            • symbol - modified action (sometimes may be needed) or nil

                                                                                                            40.3.21. initWidgets

                                                                                                            Set widgets according to internally stored settings global only because of testsuites

                                                                                                            Function parameters

                                                                                                            • list<map<string, any> > widgets

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.22. mergeFunctions

                                                                                                            Add fallback functions to a widget global only because of testsuites

                                                                                                            Function parameters

                                                                                                            • list<map <string, any> > widgets

                                                                                                            • map<any, any> functions

                                                                                                            Return value

                                                                                                            • list<map <string, any> > - a list of modified widget description maps

                                                                                                            40.3.23. prepareWidget

                                                                                                            Prepare a widget for usage

                                                                                                            Function parameters

                                                                                                            • map<string, any> widget_descr

                                                                                                            Return value

                                                                                                            • map<string, any> - modified widget description map

                                                                                                            40.3.24. saveWidgets

                                                                                                            Save changes of widget after event generated global only because of testsuites CWMTab uses it too

                                                                                                            Function parameters

                                                                                                            • list<map<string,any> > widgets

                                                                                                            • map event

                                                                                                            Return value

                                                                                                            • void

                                                                                                            40.3.25. validateWidget

                                                                                                            Validate single widget

                                                                                                            Function parameters

                                                                                                            • map<string, any> widget

                                                                                                            • map event

                                                                                                            • string key

                                                                                                            Return value

                                                                                                            • boolean - true if validation succeeded

                                                                                                            40.3.26. validateWidgets

                                                                                                            Validate dialog contents for allow it to be saved

                                                                                                            Function parameters

                                                                                                            • list<map <string, any> > widgets

                                                                                                            • map event

                                                                                                            Return value

                                                                                                            • boolean - true if everything is OK, false if something is wrong

                                                                                                            40.4. Global Variables

                                                                                                            40.5. Module Requirements

                                                                                                            40.5.1. Module Imports

                                                                                                            • Label
                                                                                                            • Report
                                                                                                            • Wizard

                                                                                                            40.5.2. Module Includes

                                                                                                              41. CWMFirewallInterfaces

                                                                                                              Routines for selecting interfaces opened in firewall

                                                                                                              41.1. Authors

                                                                                                              • Jiri Srain <jsrain@suse.cz>

                                                                                                              41.2. Summary of Module Globals

                                                                                                              List of Global Functions

                                                                                                              List of Global Variables

                                                                                                                41.3. Global Functions

                                                                                                                41.3.1. CreateInterfacesWidget

                                                                                                                Get the widget description map

                                                                                                                Function parameters

                                                                                                                • map<string,any> settings

                                                                                                                Return value

                                                                                                                • map<string,any> - the widget description map

                                                                                                                41.3.2. CreateOpenFirewallWidget

                                                                                                                Get the widget description map of the firewall enablement widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> settings

                                                                                                                Return value

                                                                                                                • map<string,any> - the widget description map

                                                                                                                41.3.3. DisableOpenFirewallWidget

                                                                                                                Disable the whole firewal widget

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.4. DisplayDetailsPopup

                                                                                                                Display the firewall interfaces selection as a popup

                                                                                                                Function parameters

                                                                                                                • map<string,any> settings

                                                                                                                Return value

                                                                                                                • symbol - return value of the dialog

                                                                                                                41.3.5. EnableOpenFirewallWidget

                                                                                                                Enable the whole firewal widget

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.6. InitAllowedInterfaces

                                                                                                                Initialize the list of allowed interfaces Changes the internal variables

                                                                                                                Function parameters

                                                                                                                • list<string> services

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.7. InterfacesHandle

                                                                                                                Handle function of the widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • symbol - for wizard sequencer or nil

                                                                                                                41.3.8. InterfacesHandleWrapper

                                                                                                                Handle function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • symbol - for wizard sequencer or nil

                                                                                                                41.3.9. InterfacesInit

                                                                                                                Init function of the widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.10. InterfacesInitWrapper

                                                                                                                Init function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.11. InterfacesStore

                                                                                                                Store function of the widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.12. InterfacesStoreWrapper

                                                                                                                Store function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.13. InterfacesValidate

                                                                                                                Validate function of the widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • boolean - true if validation succeeded, false otherwise

                                                                                                                41.3.14. InterfacesValidateWrapper

                                                                                                                Validate function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • boolean - true if validation succeeded, false otherwise

                                                                                                                41.3.15. Modified

                                                                                                                Check if settings were modified by the user

                                                                                                                Return value

                                                                                                                • boolean - true if settings were modified

                                                                                                                41.3.16. OpenFirewallHandle

                                                                                                                Handle the immediate start and stop of the service

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • symbol - always nil

                                                                                                                41.3.17. OpenFirewallHandleWrapper

                                                                                                                Handle the immediate start and stop of the service

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • symbol - always nil

                                                                                                                41.3.18. OpenFirewallHelp

                                                                                                                Get the help text to the firewall opening widget

                                                                                                                Function parameters

                                                                                                                • boolean restart_displayed

                                                                                                                Return value

                                                                                                                • string - help text

                                                                                                                41.3.19. OpenFirewallHelpTemplate

                                                                                                                Get the template for the help text to the firewall opening widget

                                                                                                                Function parameters

                                                                                                                • boolean restart_displayed

                                                                                                                Return value

                                                                                                                • string - help text template with %1 and %2 placeholders

                                                                                                                41.3.20. OpenFirewallInit

                                                                                                                Initialize the open firewall widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.21. OpenFirewallInitWrapper

                                                                                                                Init function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.22. OpenFirewallModified

                                                                                                                Check if the widget was modified

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                Return value

                                                                                                                • boolean - true if widget was modified

                                                                                                                41.3.23. OpenFirewallStore

                                                                                                                Store function of the widget

                                                                                                                Function parameters

                                                                                                                • map<string,any> widget

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.24. OpenFirewallStoreWrapper

                                                                                                                Store function of the widget

                                                                                                                Function parameters

                                                                                                                • string key

                                                                                                                • map event

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.3.25. OpenFirewallWidgetExists

                                                                                                                Check whether the whole firewall widget ( open port checkbox and fw details button) exists

                                                                                                                Return value

                                                                                                                • boolean - true if both widgets exist

                                                                                                                41.3.26. StoreAllowedInterfaces

                                                                                                                Store the list of allowed interfaces Users the internal variables

                                                                                                                Function parameters

                                                                                                                • list<string> services

                                                                                                                Return value

                                                                                                                • void

                                                                                                                41.4. Global Variables

                                                                                                                41.5. Module Requirements

                                                                                                                41.5.1. Module Imports

                                                                                                                • CWM
                                                                                                                • Label
                                                                                                                • Mode
                                                                                                                • NetworkInterfaces
                                                                                                                • Popup
                                                                                                                • Report
                                                                                                                • Stage
                                                                                                                • SuSEFirewall
                                                                                                                • SuSEFirewallProposal

                                                                                                                41.5.2. Module Includes

                                                                                                                  42. CWMServiceStart

                                                                                                                  Routines for service start widget handling

                                                                                                                  42.1. Authors

                                                                                                                  • Jiri Srain <jsrain@suse.cz>

                                                                                                                  42.2. Summary of Module Globals

                                                                                                                  List of Global Functions

                                                                                                                  List of Global Variables

                                                                                                                    42.3. Global Functions

                                                                                                                    42.3.1. AutoStartHelp

                                                                                                                    Get the help text to the auto start widget

                                                                                                                    Return value

                                                                                                                    • string - help text

                                                                                                                    42.3.2. AutoStartHelpTemplate

                                                                                                                    Get the template for the help text to the auto start widget

                                                                                                                    Return value

                                                                                                                    • string - help text template with %1 and %2 placeholders

                                                                                                                    42.3.3. AutoStartHelpXinetdTemplate

                                                                                                                    Get the template for the help text to the auto start widget

                                                                                                                    Return value

                                                                                                                    • string - help text template with %1 and %2 placeholders

                                                                                                                    42.3.4. AutoStartInit

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.5. AutoStartInitWrapper

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.6. AutoStartStore

                                                                                                                    Store function of the widget

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.7. AutoStartStoreWrapper

                                                                                                                    Store function of the widget

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.8. AutoStartXinetdHelp

                                                                                                                    Get the help text to the auto start widget

                                                                                                                    Return value

                                                                                                                    • string - help text

                                                                                                                    42.3.9. CreateAutoStartWidget

                                                                                                                    Get the widget description map of the widget for service auto starting settings

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> settings

                                                                                                                    Return value

                                                                                                                    • map<string,any> - the widget description map

                                                                                                                    42.3.10. CreateLdapWidget

                                                                                                                    Get the widget description map of the LDAP enablement widget TODO: Find a file to move to

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> settings

                                                                                                                    Return value

                                                                                                                    • map<string,any> - the widget description map

                                                                                                                    42.3.11. CreateStartStopWidget

                                                                                                                    Get the widget description map for immediate service start/stop and appropriate actions

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> settings

                                                                                                                    Return value

                                                                                                                    • map<string,any> - the widget description map

                                                                                                                    42.3.12. EnableLdapHelp

                                                                                                                    Get the help text to the LDAP enablement widget

                                                                                                                    Return value

                                                                                                                    • string - help text

                                                                                                                    42.3.13. EnableLdapHelpTemplate

                                                                                                                    Get the template for the help text to the LDAP enablement widget

                                                                                                                    Return value

                                                                                                                    • string - help text template with %1 and %2 placeholders

                                                                                                                    42.3.14. LdapHandle

                                                                                                                    Handle function of the widget

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • symbol - for wizard sequencer or nil

                                                                                                                    42.3.15. LdapHandleWrapper

                                                                                                                    Handle function of the widget

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • symbol - for wizard sequencer or nil

                                                                                                                    42.3.16. LdapInit

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.17. LdapInitWrapper

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.18. StartStopHandle

                                                                                                                    Handle the immediate start and stop of the service

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • symbol - always nil

                                                                                                                    42.3.19. StartStopHandleWrapper

                                                                                                                    Handle the immediate start and stop of the service

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    • map event

                                                                                                                    Return value

                                                                                                                    • symbol - always nil

                                                                                                                    42.3.20. StartStopHelp

                                                                                                                    Get the help text to the start/stop widget

                                                                                                                    Function parameters

                                                                                                                    • boolean restart_displayed

                                                                                                                    Return value

                                                                                                                    • string - help text

                                                                                                                    42.3.21. StartStopHelpTemplate

                                                                                                                    Get the template for the help text to the start/stop widget

                                                                                                                    Function parameters

                                                                                                                    • boolean restart_displayed

                                                                                                                    Return value

                                                                                                                    • string - help text template with %1 and %2 placeholders

                                                                                                                    42.3.22. StartStopInit

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • map<string,any> widget

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.3.23. StartStopInitWrapper

                                                                                                                    Init function of the widget

                                                                                                                    Function parameters

                                                                                                                    • string key

                                                                                                                    Return value

                                                                                                                    • void

                                                                                                                    42.4. Global Variables

                                                                                                                    42.5. Module Requirements

                                                                                                                    42.5.1. Module Imports

                                                                                                                    • CWM
                                                                                                                    • Mode
                                                                                                                    • ProductFeatures
                                                                                                                    • Service

                                                                                                                    42.5.2. Module Includes

                                                                                                                      43. CWMTab

                                                                                                                      Routines for tab widget handling

                                                                                                                      43.1. Authors

                                                                                                                      • Jiri Srain <jsrain@suse.cz>

                                                                                                                      43.2. Summary of Module Globals

                                                                                                                      List of Global Functions

                                                                                                                      • CleanUp - Clean up function of the widget

                                                                                                                      • CreateWidget - Get the widget description map

                                                                                                                      • CurrentTab - Get the ID of the currently displayed tab

                                                                                                                      • Handle - Handle function of the widget

                                                                                                                      • HandleWrapper - Handle function of the widget

                                                                                                                      • Init - Init function of the widget

                                                                                                                      • InitWrapper - Init function of the widget

                                                                                                                      • LastTab - Get the ID of the last displayed tab (after CWM::Run is done). It is needed because of bnc#134386.

                                                                                                                      • Store - Store function of the widget

                                                                                                                      • Validate - Validate function of the widget

                                                                                                                      List of Global Variables

                                                                                                                        43.3. Global Functions

                                                                                                                        43.3.1. CleanUp

                                                                                                                        Clean up function of the widget

                                                                                                                        Function parameters

                                                                                                                        • string key

                                                                                                                        Return value

                                                                                                                        • void

                                                                                                                        43.3.2. CreateWidget

                                                                                                                        Get the widget description map

                                                                                                                        Function parameters

                                                                                                                        • map settings

                                                                                                                        Return value

                                                                                                                        • map<string,any> - the widget description map

                                                                                                                        43.3.3. CurrentTab

                                                                                                                        Get the ID of the currently displayed tab

                                                                                                                        Return value

                                                                                                                        • string - the ID of the currently displayed tab

                                                                                                                        43.3.4. Handle

                                                                                                                        Handle function of the widget

                                                                                                                        Function parameters

                                                                                                                        • map<string,any> widget

                                                                                                                        • string key

                                                                                                                        • map event

                                                                                                                        Return value

                                                                                                                        • symbol - for wizard sequencer or nil

                                                                                                                        43.3.5. HandleWrapper

                                                                                                                        Handle function of the widget

                                                                                                                        Function parameters

                                                                                                                        • string key

                                                                                                                        • map event

                                                                                                                        Return value

                                                                                                                        • symbol - for wizard sequencer or nil

                                                                                                                        43.3.6. Init

                                                                                                                        Init function of the widget

                                                                                                                        Function parameters

                                                                                                                        • map<string,any> widget

                                                                                                                        • string key

                                                                                                                        Return value

                                                                                                                        • void

                                                                                                                        43.3.7. InitWrapper

                                                                                                                        Init function of the widget

                                                                                                                        Function parameters

                                                                                                                        • string key

                                                                                                                        Return value

                                                                                                                        • void

                                                                                                                        43.3.8. LastTab

                                                                                                                        Get the ID of the last displayed tab (after CWM::Run is done). It is needed because of bnc#134386.

                                                                                                                        Return value

                                                                                                                        • string - the ID of the last displayed tab

                                                                                                                        43.3.9. Store

                                                                                                                        Store function of the widget

                                                                                                                        Function parameters

                                                                                                                        • string key

                                                                                                                        • map event

                                                                                                                        Return value

                                                                                                                        • void

                                                                                                                        43.3.10. Validate

                                                                                                                        Validate function of the widget

                                                                                                                        Function parameters

                                                                                                                        • string key

                                                                                                                        • map event

                                                                                                                        Return value

                                                                                                                        • boolean

                                                                                                                        43.4. Global Variables

                                                                                                                        43.5. Module Requirements

                                                                                                                        43.5.1. Module Imports

                                                                                                                        • CWM
                                                                                                                        • Wizard

                                                                                                                        43.5.2. Module Includes

                                                                                                                          44. CWMTsigKeys

                                                                                                                          Routines for management of TSIG keys

                                                                                                                          44.1. Authors

                                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                                          44.2. Summary of Module Globals

                                                                                                                          List of Global Functions

                                                                                                                          List of Global Variables

                                                                                                                            44.3. Global Functions

                                                                                                                            44.3.1. AnalyzeTSIGKeyFile

                                                                                                                            Analyze file that may contain TSIG keys

                                                                                                                            Function parameters

                                                                                                                            • string filename

                                                                                                                            Return value

                                                                                                                            • list<string> - a list of all TSIG key IDs in the file

                                                                                                                            44.3.2. CreateWidget

                                                                                                                            Get the widget description map

                                                                                                                            Function parameters

                                                                                                                            • map<string,any> settings

                                                                                                                            Return value

                                                                                                                            • map<string,any> - a map the widget description map

                                                                                                                            44.3.3. DeleteTSIGKeyFromDisk

                                                                                                                            Remove all 3 files holding the TSIG key data

                                                                                                                            Function parameters

                                                                                                                            • string main

                                                                                                                            Return value

                                                                                                                            • void

                                                                                                                            44.3.4. Files2KeyMaps

                                                                                                                            Transformate the list of files to the list of TSIG key description maps

                                                                                                                            Function parameters

                                                                                                                            • list<string> filenames

                                                                                                                            Return value

                                                                                                                            • list<map<string,string> > - a list of TSIG key describing maps

                                                                                                                            44.3.5. Files2Keys

                                                                                                                            Get all TSIG keys that present in the files

                                                                                                                            Function parameters

                                                                                                                            • list<string> filenames

                                                                                                                            Return value

                                                                                                                            • list<string> - a list of all TSIG key IDs

                                                                                                                            44.3.6. Handle

                                                                                                                            Handle function of the widget

                                                                                                                            Function parameters

                                                                                                                            • map<string,any> widget

                                                                                                                            • string key

                                                                                                                            • map event

                                                                                                                            Return value

                                                                                                                            • symbol - for wizard sequencer or nil

                                                                                                                            44.3.7. HandleWrapper

                                                                                                                            Handle function of the widget

                                                                                                                            Function parameters

                                                                                                                            • string key

                                                                                                                            • map event

                                                                                                                            Return value

                                                                                                                            • symbol - for wizard sequencer or nil

                                                                                                                            44.3.8. Init

                                                                                                                            Init function of the widget

                                                                                                                            Function parameters

                                                                                                                            • map<string,any> widget

                                                                                                                            • string key

                                                                                                                            Return value

                                                                                                                            • void

                                                                                                                            44.3.9. InitWrapper

                                                                                                                            Store function of the widget

                                                                                                                            Function parameters

                                                                                                                            • string key

                                                                                                                            Return value

                                                                                                                            • void

                                                                                                                            44.3.10. NormalizeFilename

                                                                                                                            Remove leading and trailibg blanks and quotes from file name

                                                                                                                            Function parameters

                                                                                                                            • string filename

                                                                                                                            Return value

                                                                                                                            • string - file name without leading/trailing quotes and blanks

                                                                                                                            44.3.11. Store

                                                                                                                            Store function of the widget

                                                                                                                            Function parameters

                                                                                                                            • map<string,any> widget

                                                                                                                            • string key

                                                                                                                            • map event

                                                                                                                            Return value

                                                                                                                            • void

                                                                                                                            44.3.12. StoreWrapper

                                                                                                                            Store function of the widget

                                                                                                                            Function parameters

                                                                                                                            • string key

                                                                                                                            • map event

                                                                                                                            Return value

                                                                                                                            • void

                                                                                                                            44.4. Global Variables

                                                                                                                            44.5. Module Requirements

                                                                                                                            44.5.1. Module Imports

                                                                                                                            • CWM
                                                                                                                            • Label
                                                                                                                            • Popup
                                                                                                                            • Report

                                                                                                                            44.5.2. Module Includes

                                                                                                                              45. CaMgm

                                                                                                                              Managing CAs, Requests and Certificate

                                                                                                                              45.1. Authors

                                                                                                                              • Stefan Schubert <schubi@suse.de>

                                                                                                                              45.2. Summary of Module Globals

                                                                                                                              List of Global Functions

                                                                                                                                List of Global Variables

                                                                                                                                45.3. Global Functions

                                                                                                                                45.4. Global Variables

                                                                                                                                45.4.1. autoYaSTSettings

                                                                                                                                AutoYaST Settings Map

                                                                                                                                45.4.2. certificateSequence

                                                                                                                                sequence for creating CA and certificates

                                                                                                                                45.4.3. currentCA

                                                                                                                                selected CA

                                                                                                                                45.4.4. currentCertificate

                                                                                                                                selected certificate

                                                                                                                                45.4.5. currentDefault

                                                                                                                                selected default type

                                                                                                                                45.4.6. currentRequest

                                                                                                                                selected Request

                                                                                                                                45.4.7. emailList

                                                                                                                                variables for new CA/Certificate/Request

                                                                                                                                45.4.8. passwdMap

                                                                                                                                Password map for CA

                                                                                                                                45.4.9. prop_settingsWritten

                                                                                                                                settings for proposal

                                                                                                                                45.5. Module Requirements

                                                                                                                                45.5.1. Module Imports

                                                                                                                                • Progress
                                                                                                                                • Report
                                                                                                                                • Summary

                                                                                                                                45.5.2. Module Includes

                                                                                                                                  46. Call

                                                                                                                                  Workaround for CallFunction problems

                                                                                                                                  46.1. Authors

                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                  46.2. Summary of Module Globals

                                                                                                                                  List of Global Functions

                                                                                                                                  • Function - Workaround function for WFM::CallFunction scope problems (#22486). Same use as WFM::CallFunction.

                                                                                                                                  List of Global Variables

                                                                                                                                    46.3. Global Functions

                                                                                                                                    46.3.1. Function

                                                                                                                                    Workaround function for WFM::CallFunction scope problems (#22486). Same use as WFM::CallFunction.

                                                                                                                                    Function parameters

                                                                                                                                    • string f

                                                                                                                                    • list a

                                                                                                                                    Return value

                                                                                                                                    • any - function result

                                                                                                                                    46.4. Global Variables

                                                                                                                                    46.5. Module Requirements

                                                                                                                                    none

                                                                                                                                    47. CasaAts

                                                                                                                                    47.1. Authors

                                                                                                                                      47.2. Summary of Module Globals

                                                                                                                                      List of Global Functions

                                                                                                                                      • Abort - Abort function

                                                                                                                                      • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                      • Export - Dump the casa-ats settings to a single map (For use by autoinstallation.)

                                                                                                                                      • Import - Get all casa-ats settings from the first parameter (For use by autoinstallation.)

                                                                                                                                      • Modified - Prototypes

                                                                                                                                      • Modified - Data was modified?

                                                                                                                                      • Overview - Create an overview table with all configured cards

                                                                                                                                      • Read - Read all casa-ats settings

                                                                                                                                      • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                      • Write - Write all casa-ats settings

                                                                                                                                      List of Global Variables

                                                                                                                                      47.3. Global Functions

                                                                                                                                      47.3.1. Abort

                                                                                                                                      Abort function

                                                                                                                                      Return value

                                                                                                                                      • boolean - return true if abort

                                                                                                                                      47.3.2. AutoPackages

                                                                                                                                      Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                      Return value

                                                                                                                                      • map - with 2 lists.

                                                                                                                                      47.3.3. Export

                                                                                                                                      Dump the casa-ats settings to a single map (For use by autoinstallation.)

                                                                                                                                      Return value

                                                                                                                                      • map - Dumped settings (later acceptable by Import ())

                                                                                                                                      47.3.4. Import

                                                                                                                                      Get all casa-ats settings from the first parameter (For use by autoinstallation.)

                                                                                                                                      Function parameters

                                                                                                                                      • map settings

                                                                                                                                      Return value

                                                                                                                                      • boolean - True on success

                                                                                                                                      47.3.5. Modified

                                                                                                                                      Prototypes

                                                                                                                                      Return value

                                                                                                                                      • boolean

                                                                                                                                      47.3.6. Modified

                                                                                                                                      Data was modified?

                                                                                                                                      Return value

                                                                                                                                      • boolean - true if modified

                                                                                                                                      47.3.7. Overview

                                                                                                                                      Create an overview table with all configured cards

                                                                                                                                      Return value

                                                                                                                                      • list - table items

                                                                                                                                      47.3.8. Read

                                                                                                                                      Read all casa-ats settings

                                                                                                                                      Return value

                                                                                                                                      • boolean - true on success

                                                                                                                                      47.3.9. Summary

                                                                                                                                      Create a textual summary and a list of unconfigured cards

                                                                                                                                      Return value

                                                                                                                                      • list - summary of the current configuration

                                                                                                                                      47.3.10. Write

                                                                                                                                      Write all casa-ats settings

                                                                                                                                      Return value

                                                                                                                                      • boolean - true on success

                                                                                                                                      47.4. Global Variables

                                                                                                                                      47.4.1. Settings

                                                                                                                                      Settings Map

                                                                                                                                      47.4.2. modified

                                                                                                                                      Data was modified?

                                                                                                                                      47.4.3. proposal_valid

                                                                                                                                      47.4.4. write_only

                                                                                                                                      Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                      47.5. Module Requirements

                                                                                                                                      47.5.1. Module Imports

                                                                                                                                      • FileUtils
                                                                                                                                      • Message
                                                                                                                                      • Progress
                                                                                                                                      • Report
                                                                                                                                      • Service
                                                                                                                                      • SuSEFirewall
                                                                                                                                      • Summary

                                                                                                                                      47.5.2. Module Includes

                                                                                                                                        48. CheckMedia

                                                                                                                                        Module for checking media intergrity

                                                                                                                                        48.1. Authors

                                                                                                                                        • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                        48.2. Summary of Module Globals

                                                                                                                                        List of Global Functions

                                                                                                                                        • Info - Return information printed by checkmedia utility

                                                                                                                                        • Release - Release resources used by the subprocess

                                                                                                                                        List of Global Variables

                                                                                                                                          48.3. Global Functions

                                                                                                                                          48.3.1. Info

                                                                                                                                          Return information printed by checkmedia utility

                                                                                                                                          Return value

                                                                                                                                          • list<string>

                                                                                                                                          48.3.2. Release

                                                                                                                                          Release resources used by the subprocess

                                                                                                                                          Return value

                                                                                                                                          • void

                                                                                                                                          48.4. Global Variables

                                                                                                                                          48.5. Module Requirements

                                                                                                                                          48.5.1. Module Imports

                                                                                                                                          • Linuxrc
                                                                                                                                          • Report

                                                                                                                                          48.5.2. Module Includes

                                                                                                                                            49. Cluster

                                                                                                                                            49.1. Authors

                                                                                                                                              49.2. Summary of Module Globals

                                                                                                                                              List of Global Functions

                                                                                                                                              • Abort - Abort function

                                                                                                                                              • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                              • Export - Dump the cluster settings to a single map (For use by autoinstallation.)

                                                                                                                                              • Import - Get all cluster settings from the first parameter (For use by autoinstallation.)

                                                                                                                                              • Modified - Prototypes

                                                                                                                                              • Modified - Data was modified?

                                                                                                                                              • Overview - Create an overview table with all configured cards

                                                                                                                                              • Read - Read all cluster settings

                                                                                                                                              • SetModified - Mark as modified, for Autoyast.

                                                                                                                                              • SetWriteOnly - Set write_only flag (for autoinstalation).

                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                              • Write - Write all cluster settings

                                                                                                                                              • WriteOnly -

                                                                                                                                              List of Global Variables

                                                                                                                                                49.3. Global Functions

                                                                                                                                                49.3.1. Abort

                                                                                                                                                Abort function

                                                                                                                                                Return value

                                                                                                                                                • boolean - return true if abort

                                                                                                                                                49.3.2. AutoPackages

                                                                                                                                                Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                Return value

                                                                                                                                                • map - with 2 lists.

                                                                                                                                                49.3.3. Export

                                                                                                                                                Dump the cluster settings to a single map (For use by autoinstallation.)

                                                                                                                                                Return value

                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                49.3.4. Import

                                                                                                                                                Get all cluster settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                Function parameters

                                                                                                                                                • map settings

                                                                                                                                                Return value

                                                                                                                                                • boolean - True on success

                                                                                                                                                49.3.5. Modified

                                                                                                                                                Prototypes

                                                                                                                                                Return value

                                                                                                                                                • boolean

                                                                                                                                                49.3.6. Modified

                                                                                                                                                Data was modified?

                                                                                                                                                Return value

                                                                                                                                                • boolean - true if modified

                                                                                                                                                49.3.7. Overview

                                                                                                                                                Create an overview table with all configured cards

                                                                                                                                                Return value

                                                                                                                                                • list - table items

                                                                                                                                                49.3.8. Read

                                                                                                                                                Read all cluster settings

                                                                                                                                                Return value

                                                                                                                                                • boolean - true on success

                                                                                                                                                49.3.9. SetModified

                                                                                                                                                Mark as modified, for Autoyast.

                                                                                                                                                Function parameters

                                                                                                                                                • boolean value

                                                                                                                                                Return value

                                                                                                                                                • void

                                                                                                                                                49.3.10. SetWriteOnly

                                                                                                                                                Set write_only flag (for autoinstalation).

                                                                                                                                                Function parameters

                                                                                                                                                • boolean value

                                                                                                                                                Return value

                                                                                                                                                • void

                                                                                                                                                49.3.11. Summary

                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                Return value

                                                                                                                                                • list - summary of the current configuration

                                                                                                                                                49.3.12. Write

                                                                                                                                                Write all cluster settings

                                                                                                                                                Return value

                                                                                                                                                • boolean - true on success

                                                                                                                                                49.3.13. WriteOnly

                                                                                                                                                Return value

                                                                                                                                                • boolean - true if module is marked as "write only" (don't start services etc...)

                                                                                                                                                49.4. Global Variables

                                                                                                                                                49.5. Module Requirements

                                                                                                                                                49.5.1. Module Imports

                                                                                                                                                • Message
                                                                                                                                                • PackageSystem
                                                                                                                                                • Progress
                                                                                                                                                • Report
                                                                                                                                                • SuSEFirewall
                                                                                                                                                • Summary

                                                                                                                                                49.5.2. Module Includes

                                                                                                                                                  50. CommandLine

                                                                                                                                                  Command line interface for YaST2 modules

                                                                                                                                                  50.1. Authors

                                                                                                                                                  • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                  50.2. Summary of Module Globals

                                                                                                                                                  List of Global Functions

                                                                                                                                                  • Abort - Abort the command line handling

                                                                                                                                                  • Aborted - User asked for abort (forgetting the changes)

                                                                                                                                                  • Command - Get next user-given command

                                                                                                                                                  • Done - Are there some commands to be processed?

                                                                                                                                                  • Error - Print an Error Message

                                                                                                                                                  • Init - Initialize Module

                                                                                                                                                  • Interactive - Is module started in interactive command-line mode?

                                                                                                                                                  • Parse - Parse a list of arguments.

                                                                                                                                                  • PasswordInput - Read input from command line

                                                                                                                                                  • Print - Print a String

                                                                                                                                                  • PrintNoCR - Print a String, don't add a trailing newline character

                                                                                                                                                  • PrintVerbose - Same as Print(), but the string is printed only when verbose command line mode was activated

                                                                                                                                                  • PrintVerboseNoCR - Same as PrintNoCR(), but the string is printed only when verbose command line mode was activated

                                                                                                                                                  • Run - Parse the Command Line

                                                                                                                                                  • Scan - Scan a command line from stdin, return it split into a list

                                                                                                                                                  • StartGUI - Should module start UI?

                                                                                                                                                  • UniqueOption - Check uniqueness of an option

                                                                                                                                                  • UserInput - Read input from command line

                                                                                                                                                  • Verbose - Return verbose flag boolean verbose flag

                                                                                                                                                  • YesNo - Ask user, commandline equivalent of Popup::YesNo()

                                                                                                                                                  List of Global Variables

                                                                                                                                                    50.3. Global Functions

                                                                                                                                                    50.3.1. Abort

                                                                                                                                                    Abort the command line handling

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.2. Aborted

                                                                                                                                                    User asked for abort (forgetting the changes)

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true, if the user asked abort

                                                                                                                                                    50.3.3. Command

                                                                                                                                                    Get next user-given command

                                                                                                                                                    Return value

                                                                                                                                                    • map - of the new command. If there are no more commands, it returns exit or abort depending on the result user asked for.

                                                                                                                                                    See also:

                                                                                                                                                    • Parse

                                                                                                                                                    50.3.4. Done

                                                                                                                                                    Are there some commands to be processed?

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true, if there is no more commands to be processed, either because the user used command line, or the interactive mode was finished

                                                                                                                                                    50.3.5. Error

                                                                                                                                                    Print an Error Message

                                                                                                                                                    Function parameters

                                                                                                                                                    • string message

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.6. Init

                                                                                                                                                    Initialize Module

                                                                                                                                                    Function parameters

                                                                                                                                                    • map cmdlineinfo

                                                                                                                                                    • list<any> args

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true, if there are some commands to be processed

                                                                                                                                                    See also:

                                                                                                                                                    • Command

                                                                                                                                                    50.3.7. Interactive

                                                                                                                                                    Is module started in interactive command-line mode?

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true, if the user asked for interactive command-line mode

                                                                                                                                                    50.3.8. Parse

                                                                                                                                                    Parse a list of arguments.

                                                                                                                                                    Function parameters

                                                                                                                                                    • list<any> arguments

                                                                                                                                                    Return value

                                                                                                                                                    • map<string, any> - containing the command and it's option. In case of error it is an empty map.

                                                                                                                                                    50.3.9. PasswordInput

                                                                                                                                                    Read input from command line

                                                                                                                                                    Function parameters

                                                                                                                                                    • string prompt

                                                                                                                                                    Return value

                                                                                                                                                    • string - Entered string

                                                                                                                                                    50.3.10. Print

                                                                                                                                                    Print a String

                                                                                                                                                    Function parameters

                                                                                                                                                    • string s

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.11. PrintNoCR

                                                                                                                                                    Print a String, don't add a trailing newline character

                                                                                                                                                    Function parameters

                                                                                                                                                    • string s

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.12. PrintVerbose

                                                                                                                                                    Same as Print(), but the string is printed only when verbose command line mode was activated

                                                                                                                                                    Function parameters

                                                                                                                                                    • string s

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.13. PrintVerboseNoCR

                                                                                                                                                    Same as PrintNoCR(), but the string is printed only when verbose command line mode was activated

                                                                                                                                                    Function parameters

                                                                                                                                                    • string s

                                                                                                                                                    Return value

                                                                                                                                                    • void

                                                                                                                                                    50.3.14. Run

                                                                                                                                                    Parse the Command Line

                                                                                                                                                    Function parameters

                                                                                                                                                    • map commandline

                                                                                                                                                    Return value

                                                                                                                                                    • any - false if there was an error or no changes to be written (for example "help"). true if the changes should be written, or a value returned by the handler

                                                                                                                                                    50.3.15. Scan

                                                                                                                                                    Scan a command line from stdin, return it split into a list

                                                                                                                                                    Return value

                                                                                                                                                    • list<string> - the list of command line parts, nil for end of file

                                                                                                                                                    50.3.16. StartGUI

                                                                                                                                                    Should module start UI?

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true, if the user asked for standard UI (no parameter was passed by command line)

                                                                                                                                                    50.3.17. UniqueOption

                                                                                                                                                    Check uniqueness of an option

                                                                                                                                                    Function parameters

                                                                                                                                                    • map<string, string> options

                                                                                                                                                    • list unique_options

                                                                                                                                                    Return value

                                                                                                                                                    • string - nil if there is a problem, otherwise the unique option found

                                                                                                                                                    50.3.18. UserInput

                                                                                                                                                    Read input from command line

                                                                                                                                                    Function parameters

                                                                                                                                                    • string prompt

                                                                                                                                                    Return value

                                                                                                                                                    • string - Entered string

                                                                                                                                                    50.3.19. Verbose

                                                                                                                                                    Return verbose flag boolean verbose flag

                                                                                                                                                    Return value

                                                                                                                                                    • boolean

                                                                                                                                                    50.3.20. YesNo

                                                                                                                                                    Ask user, commandline equivalent of Popup::YesNo()

                                                                                                                                                    Return value

                                                                                                                                                    • boolean - true if user entered "yes"

                                                                                                                                                    50.4. Global Variables

                                                                                                                                                    50.5. Module Requirements

                                                                                                                                                    50.5.1. Module Imports

                                                                                                                                                    • Directory
                                                                                                                                                    • Mode
                                                                                                                                                    • Report
                                                                                                                                                    • RichText
                                                                                                                                                    • RichText
                                                                                                                                                    • Stage
                                                                                                                                                    • String
                                                                                                                                                    • TypeRepository
                                                                                                                                                    • XML

                                                                                                                                                    50.5.2. Module Includes

                                                                                                                                                      51. ConfigHistory

                                                                                                                                                      51.1. Authors

                                                                                                                                                        51.2. Summary of Module Globals

                                                                                                                                                        List of Global Functions

                                                                                                                                                        • CommitChanges - Commit changes done by YaST into the SVN repo

                                                                                                                                                        • Init - Initialize before module is started Do not call CommitChanges unless Init returns true!

                                                                                                                                                        • InitFiles - Initialize specified files for version control; useful when not having whole directory under version control, but only relevant files

                                                                                                                                                        List of Global Variables

                                                                                                                                                          51.3. Global Functions

                                                                                                                                                          51.3.1. CommitChanges

                                                                                                                                                          Commit changes done by YaST into the SVN repo

                                                                                                                                                          Function parameters

                                                                                                                                                          • string module_name

                                                                                                                                                          Return value

                                                                                                                                                          • boolean - true on success, false on failure

                                                                                                                                                          51.3.2. Init

                                                                                                                                                          Initialize before module is started Do not call CommitChanges unless Init returns true!

                                                                                                                                                          Return value

                                                                                                                                                          • boolean - true on success, false on failure

                                                                                                                                                          51.3.3. InitFiles

                                                                                                                                                          Initialize specified files for version control; useful when not having whole directory under version control, but only relevant files

                                                                                                                                                          Function parameters

                                                                                                                                                          • list<string> files

                                                                                                                                                          Return value

                                                                                                                                                          • boolean - true on success, false otherwise

                                                                                                                                                          51.4. Global Variables

                                                                                                                                                          51.5. Module Requirements

                                                                                                                                                          none

                                                                                                                                                          52. Confirm

                                                                                                                                                          Confirmation routines

                                                                                                                                                          52.1. Authors

                                                                                                                                                          • Michal Svec <msvec@suse.cz>

                                                                                                                                                          52.2. Summary of Module Globals

                                                                                                                                                          List of Global Functions

                                                                                                                                                          • Delete - Opens a popup yes/no confirmation.

                                                                                                                                                          • DeleteSelected - Opens a popup yes/no confirmation.

                                                                                                                                                          • Detection - Confirm hardware detection (only in manual installation)

                                                                                                                                                          • MustBeRoot - If we are running as root, return true. Otherwise ask the user whether we should continue even though things might not work

                                                                                                                                                          List of Global Variables

                                                                                                                                                            52.3. Global Functions

                                                                                                                                                            52.3.1. Delete

                                                                                                                                                            Opens a popup yes/no confirmation.

                                                                                                                                                            Function parameters

                                                                                                                                                            • string delete

                                                                                                                                                            Return value

                                                                                                                                                            • boolean - delete selected entry

                                                                                                                                                            52.3.2. DeleteSelected

                                                                                                                                                            Opens a popup yes/no confirmation.

                                                                                                                                                            Return value

                                                                                                                                                            • boolean - delete selected entry

                                                                                                                                                            52.3.3. Detection

                                                                                                                                                            Confirm hardware detection (only in manual installation)

                                                                                                                                                            Function parameters

                                                                                                                                                            • string class

                                                                                                                                                            • string icon_name

                                                                                                                                                            Return value

                                                                                                                                                            • boolean - true on continue

                                                                                                                                                            52.3.4. MustBeRoot

                                                                                                                                                            If we are running as root, return true. Otherwise ask the user whether we should continue even though things might not work

                                                                                                                                                            Return value

                                                                                                                                                            • boolean - true if running as root

                                                                                                                                                            52.4. Global Variables

                                                                                                                                                            52.5. Module Requirements

                                                                                                                                                            52.5.1. Module Imports

                                                                                                                                                            • Arch
                                                                                                                                                            • Icon
                                                                                                                                                            • Label
                                                                                                                                                            • Linuxrc
                                                                                                                                                            • Mode
                                                                                                                                                            • Popup
                                                                                                                                                            • Stage

                                                                                                                                                            52.5.2. Module Includes

                                                                                                                                                              53. Console

                                                                                                                                                              provide console specific stuff (esp. font and encoding) <BR> sysconfig /etc/sysconfig/console:<BR> <UL> <LI> CONSOLE_FONT string console font</LI> <LI> CONSOLE_SCREENMAP string console screenmap</LI> <LI> CONSOLE_UNICODEMAP string console unicode map</LI> <LI> CONSOLE_MAGIC string console magic control sequence</LI> <LI> CONSOLE_ENCODING string console encoding</LI> </UL>

                                                                                                                                                              53.1. Authors

                                                                                                                                                              • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                              53.2. Summary of Module Globals

                                                                                                                                                              List of Global Functions

                                                                                                                                                              • Check - Check current configuration This function should be called to check consistency with other modules (mentioned as Depends in the header)

                                                                                                                                                              • Console - constructor does nothing in initial mode restores console configuration from /etc/sysconfig in normal mode

                                                                                                                                                              • Init - initialize console settings

                                                                                                                                                              • Restore - restore data to system (rc.config agent) returns encoding

                                                                                                                                                              • Save - save data to system (rc.config agent)

                                                                                                                                                              • SelectFont - activate a language specific console font

                                                                                                                                                              List of Global Variables

                                                                                                                                                                53.3. Global Functions

                                                                                                                                                                53.3.1. Check

                                                                                                                                                                Check current configuration This function should be called to check consistency with other modules (mentioned as Depends in the header)

                                                                                                                                                                Return value

                                                                                                                                                                • boolean - 0 if no change 1 change due to dependency with other module 2 inconsistency detected

                                                                                                                                                                53.3.2. Console

                                                                                                                                                                constructor does nothing in initial mode restores console configuration from /etc/sysconfig in normal mode

                                                                                                                                                                Return value

                                                                                                                                                                • void

                                                                                                                                                                53.3.3. Init

                                                                                                                                                                initialize console settings

                                                                                                                                                                Return value

                                                                                                                                                                • void

                                                                                                                                                                53.3.4. Restore

                                                                                                                                                                restore data to system (rc.config agent) returns encoding

                                                                                                                                                                Return value

                                                                                                                                                                • string

                                                                                                                                                                53.3.5. Save

                                                                                                                                                                save data to system (rc.config agent)

                                                                                                                                                                Return value

                                                                                                                                                                • void

                                                                                                                                                                53.3.6. SelectFont

                                                                                                                                                                activate a language specific console font

                                                                                                                                                                Function parameters

                                                                                                                                                                • string lang

                                                                                                                                                                Return value

                                                                                                                                                                • string - encoding encoding for console i/o

                                                                                                                                                                53.4. Global Variables

                                                                                                                                                                53.5. Module Requirements

                                                                                                                                                                53.5.1. Module Imports

                                                                                                                                                                • Encoding
                                                                                                                                                                • Language
                                                                                                                                                                • Linuxrc
                                                                                                                                                                • Mode
                                                                                                                                                                • Stage

                                                                                                                                                                53.5.2. Module Includes

                                                                                                                                                                  54. Crash

                                                                                                                                                                  Handling crashes and recovery of other modules

                                                                                                                                                                  54.1. Authors

                                                                                                                                                                  • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                  54.2. Summary of Module Globals

                                                                                                                                                                  List of Global Functions

                                                                                                                                                                  • AskRun - Check whether operation was last run in moment of last fail. Return whether operation shall be run If not, return true (no reason to think that operation is unsafe), Otherwise ask user

                                                                                                                                                                  • Failed - Check whether operation failed

                                                                                                                                                                  • FailedLast - Check whether operation was last started when failed

                                                                                                                                                                  • Finish - Finish operation

                                                                                                                                                                  • LastFinished - Get last finished operation

                                                                                                                                                                  • Read - Read settings from data file to variables

                                                                                                                                                                  • Run - Start operation

                                                                                                                                                                  • Write - Write data stored in variables to data files

                                                                                                                                                                  List of Global Variables

                                                                                                                                                                  • filename - Filename of file storing crash settings

                                                                                                                                                                  54.3. Global Functions

                                                                                                                                                                  54.3.1. AskRun

                                                                                                                                                                  Check whether operation was last run in moment of last fail. Return whether operation shall be run If not, return true (no reason to think that operation is unsafe), Otherwise ask user

                                                                                                                                                                  Function parameters

                                                                                                                                                                  • string op

                                                                                                                                                                  • string question

                                                                                                                                                                  Return value

                                                                                                                                                                  • boolean - true if operation shall be started

                                                                                                                                                                  54.3.2. Failed

                                                                                                                                                                  Check whether operation failed

                                                                                                                                                                  Function parameters

                                                                                                                                                                  • string op

                                                                                                                                                                  Return value

                                                                                                                                                                  • boolean - true if yes

                                                                                                                                                                  54.3.3. FailedLast

                                                                                                                                                                  Check whether operation was last started when failed

                                                                                                                                                                  Function parameters

                                                                                                                                                                  • string op

                                                                                                                                                                  Return value

                                                                                                                                                                  • boolean - true if yes

                                                                                                                                                                  54.3.4. Finish

                                                                                                                                                                  Finish operation

                                                                                                                                                                  Function parameters

                                                                                                                                                                  • string op

                                                                                                                                                                  Return value

                                                                                                                                                                  • void

                                                                                                                                                                  54.3.5. LastFinished

                                                                                                                                                                  Get last finished operation

                                                                                                                                                                  Return value

                                                                                                                                                                  • string - operation name

                                                                                                                                                                  54.3.6. Read

                                                                                                                                                                  Read settings from data file to variables

                                                                                                                                                                  Return value

                                                                                                                                                                  • void

                                                                                                                                                                  54.3.7. Run

                                                                                                                                                                  Start operation

                                                                                                                                                                  Function parameters

                                                                                                                                                                  • string op

                                                                                                                                                                  Return value

                                                                                                                                                                  • void

                                                                                                                                                                  54.3.8. Write

                                                                                                                                                                  Write data stored in variables to data files

                                                                                                                                                                  Return value

                                                                                                                                                                  • void

                                                                                                                                                                  54.4. Global Variables

                                                                                                                                                                  54.4.1. filename

                                                                                                                                                                  Filename of file storing crash settings

                                                                                                                                                                  54.5. Module Requirements

                                                                                                                                                                  54.5.1. Module Imports

                                                                                                                                                                  • Popup

                                                                                                                                                                  54.5.2. Module Includes

                                                                                                                                                                    55. Cron

                                                                                                                                                                    Read and Write Crontabs

                                                                                                                                                                    55.1. Authors

                                                                                                                                                                    • Anas Nashif <nashif@suse.de>

                                                                                                                                                                    55.2. Summary of Module Globals

                                                                                                                                                                    List of Global Functions

                                                                                                                                                                    • AddSimple - Add a simple cron job with comment and env. variables

                                                                                                                                                                    • Read - Read crontab contents

                                                                                                                                                                    • Write - Write crontab contents

                                                                                                                                                                    List of Global Variables

                                                                                                                                                                      55.3. Global Functions

                                                                                                                                                                      55.3.1. AddSimple

                                                                                                                                                                      Add a simple cron job with comment and env. variables

                                                                                                                                                                      Function parameters

                                                                                                                                                                      • string comment

                                                                                                                                                                      • map envs

                                                                                                                                                                      • string command

                                                                                                                                                                      • map event

                                                                                                                                                                      • string file

                                                                                                                                                                      Return value

                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                      55.3.2. Read

                                                                                                                                                                      Read crontab contents

                                                                                                                                                                      Function parameters

                                                                                                                                                                      • string filename

                                                                                                                                                                      • map options

                                                                                                                                                                      Return value

                                                                                                                                                                      • list - crontab contents

                                                                                                                                                                      55.3.3. Write

                                                                                                                                                                      Write crontab contents

                                                                                                                                                                      Function parameters

                                                                                                                                                                      • string filename

                                                                                                                                                                      • list blocks

                                                                                                                                                                      Return value

                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                      55.4. Global Variables

                                                                                                                                                                      55.5. Module Requirements

                                                                                                                                                                      none

                                                                                                                                                                      56. CustomDialogs

                                                                                                                                                                      Installation mode

                                                                                                                                                                      56.1. Authors

                                                                                                                                                                      • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                      56.2. Summary of Module Globals

                                                                                                                                                                      List of Global Functions

                                                                                                                                                                        List of Global Variables

                                                                                                                                                                          56.3. Global Functions

                                                                                                                                                                          56.4. Global Variables

                                                                                                                                                                          56.5. Module Requirements

                                                                                                                                                                          none

                                                                                                                                                                          57. DASDController

                                                                                                                                                                          Controller settings, input and output functions

                                                                                                                                                                          57.1. Authors

                                                                                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                          57.2. Summary of Module Globals

                                                                                                                                                                          List of Global Functions

                                                                                                                                                                          • Abort - Abort function

                                                                                                                                                                          • ActivateDisk - Activate selected Disks

                                                                                                                                                                          • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                          • Available - Is this kind of disk controller available?

                                                                                                                                                                          • DeactivateDisk - Activate selected Disks

                                                                                                                                                                          • Export - Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                          • FormatDisks - Activate selected Disks

                                                                                                                                                                          • FourDigitHex - Translate integer number to its hexadecimal representation with leading 0x and exactliy 4 hexadecimal numbers

                                                                                                                                                                          • GetPartitionInfo - Get partitioninfo

                                                                                                                                                                          • Import - Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                          • IsAvailable - Check if DASD subsystem is available

                                                                                                                                                                          • Modified - Prototypes

                                                                                                                                                                          • Modified - Data was modified?

                                                                                                                                                                          • ProbeDisks - Probe for DASD disks

                                                                                                                                                                          • Read - Read all controller settings

                                                                                                                                                                          • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                          • Write - Write all controller settings

                                                                                                                                                                          List of Global Variables

                                                                                                                                                                          • modified - Data was modified?

                                                                                                                                                                          • proposal_valid -

                                                                                                                                                                          • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                          57.3. Global Functions

                                                                                                                                                                          57.3.1. Abort

                                                                                                                                                                          Abort function

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - blah blah lahjk

                                                                                                                                                                          57.3.2. ActivateDisk

                                                                                                                                                                          Activate selected Disks

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • string channel

                                                                                                                                                                          • boolean diag

                                                                                                                                                                          Return value

                                                                                                                                                                          • void

                                                                                                                                                                          57.3.3. AutoPackages

                                                                                                                                                                          Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                          Return value

                                                                                                                                                                          • map - with 2 lists.

                                                                                                                                                                          57.3.4. Available

                                                                                                                                                                          Is this kind of disk controller available?

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - true if it is

                                                                                                                                                                          57.3.5. DeactivateDisk

                                                                                                                                                                          Activate selected Disks

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • string channel

                                                                                                                                                                          • boolean diag

                                                                                                                                                                          Return value

                                                                                                                                                                          • void

                                                                                                                                                                          57.3.6. Export

                                                                                                                                                                          Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                          Return value

                                                                                                                                                                          • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                          57.3.7. FormatDisks

                                                                                                                                                                          Activate selected Disks

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • list<string> disks_list

                                                                                                                                                                          • integer par

                                                                                                                                                                          • boolean write_vl

                                                                                                                                                                          • boolean interactive

                                                                                                                                                                          Return value

                                                                                                                                                                          • void

                                                                                                                                                                          57.3.8. FourDigitHex

                                                                                                                                                                          Translate integer number to its hexadecimal representation with leading 0x and exactliy 4 hexadecimal numbers

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • integer i

                                                                                                                                                                          Return value

                                                                                                                                                                          • string - hexadecimal number

                                                                                                                                                                          57.3.9. GetPartitionInfo

                                                                                                                                                                          Get partitioninfo

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • string disk

                                                                                                                                                                          Return value

                                                                                                                                                                          • string - GetPartitionInfo string The info

                                                                                                                                                                          57.3.10. Import

                                                                                                                                                                          Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                          Function parameters

                                                                                                                                                                          • map settings

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - True on success

                                                                                                                                                                          57.3.11. IsAvailable

                                                                                                                                                                          Check if DASD subsystem is available

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - True if more than one disk

                                                                                                                                                                          57.3.12. Modified

                                                                                                                                                                          Prototypes

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean

                                                                                                                                                                          57.3.13. Modified

                                                                                                                                                                          Data was modified?

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - true if modified

                                                                                                                                                                          57.3.14. ProbeDisks

                                                                                                                                                                          Probe for DASD disks

                                                                                                                                                                          Return value

                                                                                                                                                                          • void

                                                                                                                                                                          57.3.15. Read

                                                                                                                                                                          Read all controller settings

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                          57.3.16. Summary

                                                                                                                                                                          Create a textual summary and a list of unconfigured cards

                                                                                                                                                                          Return value

                                                                                                                                                                          • list - summary of the current configuration

                                                                                                                                                                          57.3.17. Write

                                                                                                                                                                          Write all controller settings

                                                                                                                                                                          Return value

                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                          57.4. Global Variables

                                                                                                                                                                          57.4.1. modified

                                                                                                                                                                          Data was modified?

                                                                                                                                                                          57.4.2. proposal_valid

                                                                                                                                                                          57.4.3. write_only

                                                                                                                                                                          Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                          57.5. Module Requirements

                                                                                                                                                                          57.5.1. Module Imports

                                                                                                                                                                          • Arch
                                                                                                                                                                          • Mode
                                                                                                                                                                          • Progress
                                                                                                                                                                          • Report
                                                                                                                                                                          • Stage
                                                                                                                                                                          • Summary

                                                                                                                                                                          57.5.2. Module Includes

                                                                                                                                                                            58. DNS

                                                                                                                                                                            Hostname and DNS data

                                                                                                                                                                            58.1. Authors

                                                                                                                                                                            • Michal Svec <msvec@suse.cz>

                                                                                                                                                                            58.2. Summary of Module Globals

                                                                                                                                                                            List of Global Functions

                                                                                                                                                                            • Export - Dump the DNS settings to a map, for autoinstallation use.

                                                                                                                                                                            • Import - Get all the DNS configuration from a map. When called by dns_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                            • IsHostLocal - Check if hostname or IP address is local computer Used to determine if LDAP server is local (and it should be checked if required schemes are included Calls Read () function before querying any data

                                                                                                                                                                            • Read - Reads current DNS and hostname settings Includes Host,NetworkConfig::Read

                                                                                                                                                                            • ReadHostDomain - Use this host and domain name, if they are defined

                                                                                                                                                                            • ReadNameserver - Use the parameter, coming usually from install.inf, if it is defined. Used when there is nothing better.

                                                                                                                                                                            • Summary - Create DNS text summary

                                                                                                                                                                            • Write - Write new DNS and hostname settings Includes Host,NetworkConfig::Write

                                                                                                                                                                            List of Global Variables

                                                                                                                                                                            58.3. Global Functions

                                                                                                                                                                            58.3.1. Export

                                                                                                                                                                            Dump the DNS settings to a map, for autoinstallation use.

                                                                                                                                                                            Return value

                                                                                                                                                                            • map - autoinstallation settings

                                                                                                                                                                            58.3.2. Import

                                                                                                                                                                            Get all the DNS configuration from a map. When called by dns_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • map settings

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            58.3.3. IsHostLocal

                                                                                                                                                                            Check if hostname or IP address is local computer Used to determine if LDAP server is local (and it should be checked if required schemes are included Calls Read () function before querying any data

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string check_host

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if hostname is local host

                                                                                                                                                                            58.3.4. Read

                                                                                                                                                                            Reads current DNS and hostname settings Includes Host,NetworkConfig::Read

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            58.3.5. ReadHostDomain

                                                                                                                                                                            Use this host and domain name, if they are defined

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string hn

                                                                                                                                                                            • string dn

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if the hostname has been assigned

                                                                                                                                                                            58.3.6. ReadNameserver

                                                                                                                                                                            Use the parameter, coming usually from install.inf, if it is defined. Used when there is nothing better.

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string ns

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            58.3.7. Summary

                                                                                                                                                                            Create DNS text summary

                                                                                                                                                                            Return value

                                                                                                                                                                            • string - summary text

                                                                                                                                                                            58.3.8. Write

                                                                                                                                                                            Write new DNS and hostname settings Includes Host,NetworkConfig::Write

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            58.4. Global Variables

                                                                                                                                                                            58.4.1. domain

                                                                                                                                                                            Domain Name (not including the host part)

                                                                                                                                                                            58.4.2. hostname

                                                                                                                                                                            Short Hostname

                                                                                                                                                                            58.4.3. modified

                                                                                                                                                                            Data was modified?

                                                                                                                                                                            58.4.4. proposal_valid

                                                                                                                                                                            Should the hostname be proposed? #152218

                                                                                                                                                                            58.5. Module Requirements

                                                                                                                                                                            58.5.1. Module Imports

                                                                                                                                                                            • Host
                                                                                                                                                                            • Hostname
                                                                                                                                                                            • IP
                                                                                                                                                                            • NetHwDetection
                                                                                                                                                                            • NetworkConfig
                                                                                                                                                                            • NetworkInterfaces
                                                                                                                                                                            • Progress
                                                                                                                                                                            • Service
                                                                                                                                                                            • String
                                                                                                                                                                            • Summary

                                                                                                                                                                            58.5.2. Module Includes

                                                                                                                                                                            • network/routines.ycp
                                                                                                                                                                            • network/runtime.ycp

                                                                                                                                                                            59. DSL

                                                                                                                                                                            DSL data

                                                                                                                                                                            59.1. Authors

                                                                                                                                                                            • Michal Svec <msvec@suse.cz>

                                                                                                                                                                            59.2. Summary of Module Globals

                                                                                                                                                                            List of Global Functions

                                                                                                                                                                            • Add - Add a new device

                                                                                                                                                                            • Adding - Used to see whether we are in the process of adding a new interface or editing an existing one.

                                                                                                                                                                            • Commit - Commit the pending operation

                                                                                                                                                                            • Delete - Delete the given device

                                                                                                                                                                            • Edit - Edit the given device

                                                                                                                                                                            • Export - Export data

                                                                                                                                                                            • Import - Import data

                                                                                                                                                                            • Modified - Data was modified?

                                                                                                                                                                            • Overview - Create an overview table with all configured devices

                                                                                                                                                                            • Propose - Propose a configuration

                                                                                                                                                                            • Read - Read all network settings from the SCR

                                                                                                                                                                            • Select - Select the given device

                                                                                                                                                                            • SelectHW - Select the hardware component

                                                                                                                                                                            • Summary - Create a textual summary and a list of unconfigured devices

                                                                                                                                                                            • UsesDevice - Return true if the device is used by any DSL connection

                                                                                                                                                                            • Write - Update the SCR according to network settings

                                                                                                                                                                            List of Global Variables

                                                                                                                                                                            • AbortFunction - Abort function return boolean return true if abort

                                                                                                                                                                            • capiadsl - Special Capi-ADSL mode -- different presets for the first device. Used for ISDN-DSL combined hardware.

                                                                                                                                                                            • interface - Ethernet network interface

                                                                                                                                                                            • modemip - DSL modem IP (used for PPTP)

                                                                                                                                                                            • pppmode - PPP mode: pppoe or pppoatm

                                                                                                                                                                            • vpivci - VPI/VCI

                                                                                                                                                                            59.3. Global Functions

                                                                                                                                                                            59.3.1. Add

                                                                                                                                                                            Add a new device

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            59.3.2. Adding

                                                                                                                                                                            Used to see whether we are in the process of adding a new interface or editing an existing one.

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - adding?

                                                                                                                                                                            59.3.3. Commit

                                                                                                                                                                            Commit the pending operation

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            59.3.4. Delete

                                                                                                                                                                            Delete the given device

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string name

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            59.3.5. Edit

                                                                                                                                                                            Edit the given device

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string name

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            59.3.6. Export

                                                                                                                                                                            Export data

                                                                                                                                                                            Return value

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

                                                                                                                                                                            59.3.7. Import

                                                                                                                                                                            Import data

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • map settings

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                            59.3.8. Modified

                                                                                                                                                                            Data was modified?

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                            59.3.9. Overview

                                                                                                                                                                            Create an overview table with all configured devices

                                                                                                                                                                            Return value

                                                                                                                                                                            • list - table items

                                                                                                                                                                            59.3.10. Propose

                                                                                                                                                                            Propose a configuration

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if something was proposed

                                                                                                                                                                            59.3.11. Read

                                                                                                                                                                            Read all network settings from the SCR

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                            59.3.12. Select

                                                                                                                                                                            Select the given device

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string dev

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                            59.3.13. SelectHW

                                                                                                                                                                            Select the hardware component

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • integer which

                                                                                                                                                                            Return value

                                                                                                                                                                            • void

                                                                                                                                                                            59.3.14. Summary

                                                                                                                                                                            Create a textual summary and a list of unconfigured devices

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • boolean split

                                                                                                                                                                            Return value

                                                                                                                                                                            • list - summary of the current configuration

                                                                                                                                                                            59.3.15. UsesDevice

                                                                                                                                                                            Return true if the device is used by any DSL connection

                                                                                                                                                                            Function parameters

                                                                                                                                                                            • string device

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true if yes

                                                                                                                                                                            59.3.16. Write

                                                                                                                                                                            Update the SCR according to network settings

                                                                                                                                                                            Return value

                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                            59.4. Global Variables

                                                                                                                                                                            59.4.1. AbortFunction

                                                                                                                                                                            Abort function return boolean return true if abort

                                                                                                                                                                            59.4.2. capiadsl

                                                                                                                                                                            Special Capi-ADSL mode -- different presets for the first device. Used for ISDN-DSL combined hardware.

                                                                                                                                                                            59.4.3. interface

                                                                                                                                                                            Ethernet network interface

                                                                                                                                                                            59.4.4. modemip

                                                                                                                                                                            DSL modem IP (used for PPTP)

                                                                                                                                                                            59.4.5. pppmode

                                                                                                                                                                            PPP mode: pppoe or pppoatm

                                                                                                                                                                            59.4.6. vpivci

                                                                                                                                                                            VPI/VCI

                                                                                                                                                                            59.5. Module Requirements

                                                                                                                                                                            59.5.1. Module Imports

                                                                                                                                                                            • Confirm
                                                                                                                                                                            • Lan
                                                                                                                                                                            • NetHwDetection
                                                                                                                                                                            • NetworkInterfaces
                                                                                                                                                                            • NetworkService
                                                                                                                                                                            • Progress
                                                                                                                                                                            • Provider
                                                                                                                                                                            • SuSEFirewall4Network
                                                                                                                                                                            • Summary

                                                                                                                                                                            59.5.2. Module Includes

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

                                                                                                                                                                            60. DefaultDesktop

                                                                                                                                                                            60.1. Authors

                                                                                                                                                                            • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                            60.2. Summary of Module Globals

                                                                                                                                                                            List of Global Functions

                                                                                                                                                                            • Description - Get the description of the currently selected desktop for the summary

                                                                                                                                                                            • Desktop - Get the currently set default desktop, nil if none set

                                                                                                                                                                            • ForceReinit - Forces new initialization...

                                                                                                                                                                            • GetAllDesktopsMap - Returns map of pre-defined default system tasks

                                                                                                                                                                            • Init - Initialize default desktop from control file if specified there

                                                                                                                                                                            • PatternsToDeselect - Get patterns which should be NOT selected for currently selected desktop

                                                                                                                                                                            • PatternsToSelect - Get patterns which should be selected for currently selected desktop

                                                                                                                                                                            • PrefferedWindowManager - Get preffered window/desktop manager for the selected desktop

                                                                                                                                                                            • SelectedDesktops - Return list installed desktops or desktop selected for installation.

                                                                                                                                                                            • SetDesktop - Set the default desktop

                                                                                                                                                                            List of Global Variables

                                                                                                                                                                              60.3. Global Functions

                                                                                                                                                                              60.3.1. Description

                                                                                                                                                                              Get the description of the currently selected desktop for the summary

                                                                                                                                                                              Return value

                                                                                                                                                                              • string - the description of the desktop

                                                                                                                                                                              60.3.2. Desktop

                                                                                                                                                                              Get the currently set default desktop, nil if none set

                                                                                                                                                                              Return value

                                                                                                                                                                              • string - desktop or nil

                                                                                                                                                                              60.3.3. ForceReinit

                                                                                                                                                                              Forces new initialization...

                                                                                                                                                                              Return value

                                                                                                                                                                              • void

                                                                                                                                                                              60.3.4. GetAllDesktopsMap

                                                                                                                                                                              Returns map of pre-defined default system tasks

                                                                                                                                                                              Return value

                                                                                                                                                                              • map <string, map> - all_system_tasks

                                                                                                                                                                              $[
                                                                                                                                                                                   "desktop ID" : $[
                                                                                                                                                                                       "desktop" : "desktop to start", // DEFAULT_WM
                                                                                                                                                                                       "order" : integer,
                                                                                                                                                                                       "label" : _("Desktop Name Visible in Dialog (localized - initial localization)"),
                                                                                                                                                                                       "label_id" : _("Desktop Name Visible in Dialog (original)"),
                                                                                                                                                                                       "description" : _("Description text of the desktop (localized - initial localization)"),
                                                                                                                                                                                       "description_id" : _("Description text of the desktop (originale)"),
                                                                                                                                                                                       "patterns" : ["list", "of", "related", "patterns"],
                                                                                                                                                                                       "icon" : "some-icon", // filename from the 64x64 directory of the current theme (without .png suffix)
                                                                                                                                                                                   ],
                                                                                                                                                                               ]

                                                                                                                                                                              60.3.5. Init

                                                                                                                                                                              Initialize default desktop from control file if specified there

                                                                                                                                                                              Return value

                                                                                                                                                                              • void

                                                                                                                                                                              60.3.6. PatternsToDeselect

                                                                                                                                                                              Get patterns which should be NOT selected for currently selected desktop

                                                                                                                                                                              Return value

                                                                                                                                                                              • list<string> - a list of patterns

                                                                                                                                                                              60.3.7. PatternsToSelect

                                                                                                                                                                              Get patterns which should be selected for currently selected desktop

                                                                                                                                                                              Return value

                                                                                                                                                                              • list<string> - a list of patterns

                                                                                                                                                                              60.3.8. PrefferedWindowManager

                                                                                                                                                                              Get preffered window/desktop manager for the selected desktop

                                                                                                                                                                              Return value

                                                                                                                                                                              • string - preffered window/desktop manager, empty if no one

                                                                                                                                                                              60.3.9. SelectedDesktops

                                                                                                                                                                              Return list installed desktops or desktop selected for installation.

                                                                                                                                                                              Return value

                                                                                                                                                                              • list <string>

                                                                                                                                                                              See also:

                                                                                                                                                                              • GetAllDesktopsMap

                                                                                                                                                                              60.3.10. SetDesktop

                                                                                                                                                                              Set the default desktop

                                                                                                                                                                              Function parameters

                                                                                                                                                                              • string new_desktop

                                                                                                                                                                              Return value

                                                                                                                                                                              • void

                                                                                                                                                                              60.4. Global Variables

                                                                                                                                                                              60.5. Module Requirements

                                                                                                                                                                              60.5.1. Module Imports

                                                                                                                                                                              • Installation
                                                                                                                                                                              • Mode
                                                                                                                                                                              • PackagesProposal
                                                                                                                                                                              • ProductControl
                                                                                                                                                                              • ProductFeatures

                                                                                                                                                                              60.5.2. Module Includes

                                                                                                                                                                                61. Desktop

                                                                                                                                                                                Handling of .desktop entries

                                                                                                                                                                                61.1. Authors

                                                                                                                                                                                • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                61.2. Summary of Module Globals

                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                • AgentPath - Optional agent path to the desktop files

                                                                                                                                                                                • Groups - YaST configuration groups

                                                                                                                                                                                • Modules - YaST configuration modules

                                                                                                                                                                                61.3. Global Functions

                                                                                                                                                                                61.3.1. GroupList

                                                                                                                                                                                Return value

                                                                                                                                                                                • list <term>

                                                                                                                                                                                61.3.2. ModuleList

                                                                                                                                                                                Function parameters

                                                                                                                                                                                • string group

                                                                                                                                                                                Return value

                                                                                                                                                                                • list <term>

                                                                                                                                                                                61.3.3. Read

                                                                                                                                                                                Read module and group data from desktop files

                                                                                                                                                                                Function parameters

                                                                                                                                                                                • list<string> Values

                                                                                                                                                                                Return value

                                                                                                                                                                                • void

                                                                                                                                                                                61.3.4. RunViaDesktop

                                                                                                                                                                                Runs a program by writing a special desktop file. Works with KDE and GNOME. Useful for kinternet, see bug 37864#c17

                                                                                                                                                                                Function parameters

                                                                                                                                                                                • string exec

                                                                                                                                                                                • list<string> args

                                                                                                                                                                                Return value

                                                                                                                                                                                • void

                                                                                                                                                                                61.3.5. Translate

                                                                                                                                                                                Function parameters

                                                                                                                                                                                • string key

                                                                                                                                                                                Return value

                                                                                                                                                                                • string

                                                                                                                                                                                61.4. Global Variables

                                                                                                                                                                                61.4.1. AgentPath

                                                                                                                                                                                Optional agent path to the desktop files

                                                                                                                                                                                61.4.2. Groups

                                                                                                                                                                                YaST configuration groups

                                                                                                                                                                                61.4.3. Modules

                                                                                                                                                                                YaST configuration modules

                                                                                                                                                                                61.5. Module Requirements

                                                                                                                                                                                61.5.1. Module Imports

                                                                                                                                                                                • Map

                                                                                                                                                                                61.5.2. Module Includes

                                                                                                                                                                                  62. DevicesSelectionBox

                                                                                                                                                                                  Expert Partitioner

                                                                                                                                                                                  62.1. Authors

                                                                                                                                                                                  • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                  62.2. Summary of Module Globals

                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                  • Create - The maps for the devices must contain the entries "device" and "size_k".

                                                                                                                                                                                  • GetSelectedDevices - Returns list with the maps of the selected devices.

                                                                                                                                                                                  • GetUnselectedDevices - Returns list with the maps of the unselected devices.

                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                    62.3. Global Functions

                                                                                                                                                                                    62.3.1. Create

                                                                                                                                                                                    The maps for the devices must contain the entries "device" and "size_k".

                                                                                                                                                                                    Function parameters

                                                                                                                                                                                    • list<map> unselected_devices

                                                                                                                                                                                    • list<map> selected_devices

                                                                                                                                                                                    • list<symbol> fields

                                                                                                                                                                                    Return value

                                                                                                                                                                                    • term

                                                                                                                                                                                    62.3.2. GetSelectedDevices

                                                                                                                                                                                    Returns list with the maps of the selected devices.

                                                                                                                                                                                    Return value

                                                                                                                                                                                    • list<map>

                                                                                                                                                                                    62.3.3. GetUnselectedDevices

                                                                                                                                                                                    Returns list with the maps of the unselected devices.

                                                                                                                                                                                    Return value

                                                                                                                                                                                    • list<map>

                                                                                                                                                                                    62.4. Global Variables

                                                                                                                                                                                    62.5. Module Requirements

                                                                                                                                                                                    62.5.1. Module Imports

                                                                                                                                                                                    • DualMultiSelectionBox
                                                                                                                                                                                    • Integer
                                                                                                                                                                                    • Storage
                                                                                                                                                                                    • StorageFields

                                                                                                                                                                                    62.5.2. Module Includes

                                                                                                                                                                                      63. DhcpServerUI

                                                                                                                                                                                      Data for configuration of dhcp-server, input and output functions.

                                                                                                                                                                                      63.1. Authors

                                                                                                                                                                                      • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                      63.2. Summary of Module Globals

                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                        63.3. Global Functions

                                                                                                                                                                                        63.3.1. DhcpServerUI

                                                                                                                                                                                        Constructor

                                                                                                                                                                                        Return value

                                                                                                                                                                                        • void

                                                                                                                                                                                        63.4. Global Variables

                                                                                                                                                                                        63.5. Module Requirements

                                                                                                                                                                                        63.5.1. Module Imports

                                                                                                                                                                                        • DhcpServer
                                                                                                                                                                                        • Mode
                                                                                                                                                                                        • Popup
                                                                                                                                                                                        • Report
                                                                                                                                                                                        • Service
                                                                                                                                                                                        • SuSEFirewall

                                                                                                                                                                                        63.5.2. Module Includes

                                                                                                                                                                                        • dhcp-server/dialogs.ycp
                                                                                                                                                                                        • dhcp-server/dialogs2.ycp
                                                                                                                                                                                        • dhcp-server/helps.ycp
                                                                                                                                                                                        • dhcp-server/options.ycp
                                                                                                                                                                                        • dhcp-server/routines.ycp
                                                                                                                                                                                        • dhcp-server/widgets.ycp
                                                                                                                                                                                        • dhcp-server/wizards.ycp

                                                                                                                                                                                        64. DialogTree

                                                                                                                                                                                        Routines for handling the dialog with tree on the left side

                                                                                                                                                                                        64.1. Authors

                                                                                                                                                                                        • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                        64.2. Summary of Module Globals

                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                        • AdjustButtons - Adjust buttons at the bottom of the dialog

                                                                                                                                                                                        • AdjustButtonsAny - Adjust buttons at the bottom of the dialog

                                                                                                                                                                                        • Run - Generic function to create dialog and handle it's events. Run the event loop over the dialog with the left tree.

                                                                                                                                                                                        • RunAndHide - Run the event loop over the dialog with the left tree. After finished, run UI::CloseDialog

                                                                                                                                                                                        • ShowAndRun - Display the dialog and run its event loop

                                                                                                                                                                                        • ShowFlat - Draw the dialog with the flat tree (only single level of the tree entries)

                                                                                                                                                                                        • ShowTree - Draw the dialog with multi-level tree

                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                          64.3. Global Functions

                                                                                                                                                                                          64.3.1. AdjustButtons

                                                                                                                                                                                          Adjust buttons at the bottom of the dialog

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • map<string,string> buttons

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • void

                                                                                                                                                                                          64.3.2. AdjustButtonsAny

                                                                                                                                                                                          Adjust buttons at the bottom of the dialog

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • map<string,any> buttons

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • void

                                                                                                                                                                                          64.3.3. Run

                                                                                                                                                                                          Generic function to create dialog and handle it's events. Run the event loop over the dialog with the left tree.

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • map<string,any> settings

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • symbol - wizard sequencer symbol

                                                                                                                                                                                          64.3.4. RunAndHide

                                                                                                                                                                                          Run the event loop over the dialog with the left tree. After finished, run UI::CloseDialog

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • map<string,any> settings

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • symbol - wizard sequencer symbol

                                                                                                                                                                                          64.3.5. ShowAndRun

                                                                                                                                                                                          Display the dialog and run its event loop

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • map<string,any> settings

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • symbol - wizard sequencer symbol

                                                                                                                                                                                          64.3.6. ShowFlat

                                                                                                                                                                                          Draw the dialog with the flat tree (only single level of the tree entries)

                                                                                                                                                                                          Function parameters

                                                                                                                                                                                          • list<string> ids_order

                                                                                                                                                                                          • map<string,map<string,any> > screens

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • void

                                                                                                                                                                                          64.3.7. ShowTree

                                                                                                                                                                                          Draw the dialog with multi-level tree

                                                                                                                                                                                          Return value

                                                                                                                                                                                          • void

                                                                                                                                                                                          64.4. Global Variables

                                                                                                                                                                                          64.5. Module Requirements

                                                                                                                                                                                          64.5.1. Module Imports

                                                                                                                                                                                          • CWM
                                                                                                                                                                                          • Label
                                                                                                                                                                                          • Wizard

                                                                                                                                                                                          64.5.2. Module Includes

                                                                                                                                                                                            65. DirInstall

                                                                                                                                                                                            Instalation into a Directory settings, input and output functions

                                                                                                                                                                                            65.1. Authors

                                                                                                                                                                                            • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                            65.2. Summary of Module Globals

                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                65.3. Global Functions

                                                                                                                                                                                                65.4. Global Variables

                                                                                                                                                                                                65.5. Module Requirements

                                                                                                                                                                                                65.5.1. Module Imports

                                                                                                                                                                                                • HTML
                                                                                                                                                                                                • Installation
                                                                                                                                                                                                • Mode
                                                                                                                                                                                                • ProductControl
                                                                                                                                                                                                • Stage
                                                                                                                                                                                                • String

                                                                                                                                                                                                65.5.2. Module Includes

                                                                                                                                                                                                  66. Directory

                                                                                                                                                                                                  Definitions of basic directories

                                                                                                                                                                                                  66.1. Authors

                                                                                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                  66.2. Summary of Module Globals

                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                  • agentdir - Directory with agents

                                                                                                                                                                                                  • bindir - Directory for binaries and scripts

                                                                                                                                                                                                  • clientdir - Directory for clients

                                                                                                                                                                                                  • custom_workflow_dir - Directory needed for custom installation workflows It can be set to the path containing additional file on a CDROM

                                                                                                                                                                                                  • datadir - Directory for data

                                                                                                                                                                                                  • desktopdir - Directory for desktop files

                                                                                                                                                                                                  • etcdir - Directory for configuration data

                                                                                                                                                                                                  • icondir - Base directory for icons

                                                                                                                                                                                                  • imagedir - Directory for images

                                                                                                                                                                                                  • includedir - Directory for includes

                                                                                                                                                                                                  • localedir - Directory for locales

                                                                                                                                                                                                  • logdir - Directory for log files

                                                                                                                                                                                                  • moduledir - Directory for modules

                                                                                                                                                                                                  • schemadir - Directory for schema (RNC,DTD,RNG)

                                                                                                                                                                                                  • scrconfdir - Directory for SCR definition files

                                                                                                                                                                                                  • themedir - Directory for themes

                                                                                                                                                                                                  • tmpdir - Directory for temporary files Must be updated with ResetTmpDir() call after the SCR change!

                                                                                                                                                                                                  • vardir - Directory for variable data

                                                                                                                                                                                                  66.3. Global Functions

                                                                                                                                                                                                  66.3.1. Directory

                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                  Return value

                                                                                                                                                                                                  • void

                                                                                                                                                                                                  66.3.2. ResetTmpDir

                                                                                                                                                                                                  Set temporary directory

                                                                                                                                                                                                  Return value

                                                                                                                                                                                                  • void

                                                                                                                                                                                                  66.4. Global Variables

                                                                                                                                                                                                  66.4.1. agentdir

                                                                                                                                                                                                  Directory with agents

                                                                                                                                                                                                  66.4.2. bindir

                                                                                                                                                                                                  Directory for binaries and scripts

                                                                                                                                                                                                  66.4.3. clientdir

                                                                                                                                                                                                  Directory for clients

                                                                                                                                                                                                  66.4.4. custom_workflow_dir

                                                                                                                                                                                                  Directory needed for custom installation workflows It can be set to the path containing additional file on a CDROM

                                                                                                                                                                                                  66.4.5. datadir

                                                                                                                                                                                                  Directory for data

                                                                                                                                                                                                  66.4.6. desktopdir

                                                                                                                                                                                                  Directory for desktop files

                                                                                                                                                                                                  66.4.7. etcdir

                                                                                                                                                                                                  Directory for configuration data

                                                                                                                                                                                                  66.4.8. icondir

                                                                                                                                                                                                  Base directory for icons

                                                                                                                                                                                                  66.4.9. imagedir

                                                                                                                                                                                                  Directory for images

                                                                                                                                                                                                  66.4.10. includedir

                                                                                                                                                                                                  Directory for includes

                                                                                                                                                                                                  66.4.11. localedir

                                                                                                                                                                                                  Directory for locales

                                                                                                                                                                                                  66.4.12. logdir

                                                                                                                                                                                                  Directory for log files

                                                                                                                                                                                                  66.4.13. moduledir

                                                                                                                                                                                                  Directory for modules

                                                                                                                                                                                                  66.4.14. schemadir

                                                                                                                                                                                                  Directory for schema (RNC,DTD,RNG)

                                                                                                                                                                                                  66.4.15. scrconfdir

                                                                                                                                                                                                  Directory for SCR definition files

                                                                                                                                                                                                  66.4.16. themedir

                                                                                                                                                                                                  Directory for themes

                                                                                                                                                                                                  66.4.17. tmpdir

                                                                                                                                                                                                  Directory for temporary files Must be updated with ResetTmpDir() call after the SCR change!

                                                                                                                                                                                                  66.4.18. vardir

                                                                                                                                                                                                  Directory for variable data

                                                                                                                                                                                                  66.5. Module Requirements

                                                                                                                                                                                                  none

                                                                                                                                                                                                  67. Distro

                                                                                                                                                                                                  Distinguish between distributions that can run YaST

                                                                                                                                                                                                  67.1. Authors

                                                                                                                                                                                                  • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                  67.2. Summary of Module Globals

                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                  • debian - Is it Debian based? Ubuntu, ...

                                                                                                                                                                                                  • fedora - Is it Fedora based? RHEL, Oracle, ...

                                                                                                                                                                                                  • suse - Is it SUSE based? openSUSE, SLES, SLED, ...

                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                    67.3. Global Functions

                                                                                                                                                                                                    67.3.1. debian

                                                                                                                                                                                                    Is it Debian based? Ubuntu, ...

                                                                                                                                                                                                    Return value

                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                    67.3.2. fedora

                                                                                                                                                                                                    Is it Fedora based? RHEL, Oracle, ...

                                                                                                                                                                                                    Return value

                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                    67.3.3. suse

                                                                                                                                                                                                    Is it SUSE based? openSUSE, SLES, SLED, ...

                                                                                                                                                                                                    Return value

                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                    67.4. Global Variables

                                                                                                                                                                                                    67.5. Module Requirements

                                                                                                                                                                                                    none

                                                                                                                                                                                                    68. DnsFakeTabs

                                                                                                                                                                                                    68.1. Authors

                                                                                                                                                                                                      68.2. Summary of Module Globals

                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                          68.3. Global Functions

                                                                                                                                                                                                          68.4. Global Variables

                                                                                                                                                                                                          68.5. Module Requirements

                                                                                                                                                                                                          none

                                                                                                                                                                                                          69. DnsServerHelperFunctions

                                                                                                                                                                                                          Module containing helper functions.

                                                                                                                                                                                                          69.1. Authors

                                                                                                                                                                                                          • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                          69.2. Summary of Module Globals

                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                            69.3. Global Functions

                                                                                                                                                                                                            69.3.1. IsReverseZone

                                                                                                                                                                                                            Returns whether zone is a reverse-zone type

                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                            • string zone

                                                                                                                                                                                                            Return value

                                                                                                                                                                                                            • boolean - if zone is reverse type

                                                                                                                                                                                                            69.4. Global Variables

                                                                                                                                                                                                            69.5. Module Requirements

                                                                                                                                                                                                            69.5.1. Module Imports

                                                                                                                                                                                                            • DnsServer
                                                                                                                                                                                                            • DnsServerAPI

                                                                                                                                                                                                            69.5.2. Module Includes

                                                                                                                                                                                                              70. DnsServerUI

                                                                                                                                                                                                              Data for configuration of dns-server, input and output functions.

                                                                                                                                                                                                              70.1. Authors

                                                                                                                                                                                                              • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                              70.2. Summary of Module Globals

                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                • popups - Map of popups for CWM

                                                                                                                                                                                                                70.3. Global Functions

                                                                                                                                                                                                                70.4. Global Variables

                                                                                                                                                                                                                70.4.1. popups

                                                                                                                                                                                                                Map of popups for CWM

                                                                                                                                                                                                                70.5. Module Requirements

                                                                                                                                                                                                                70.5.1. Module Imports

                                                                                                                                                                                                                • DnsFakeTabs
                                                                                                                                                                                                                • DnsServer
                                                                                                                                                                                                                • DnsTsigKeys
                                                                                                                                                                                                                • DnsZones
                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                70.5.2. Module Includes

                                                                                                                                                                                                                • dns-server/dialog-installwizard.ycp
                                                                                                                                                                                                                • dns-server/dialog-main.ycp
                                                                                                                                                                                                                • dns-server/dialog-masterzone.ycp
                                                                                                                                                                                                                • dns-server/dialogs.ycp
                                                                                                                                                                                                                • dns-server/helps.ycp
                                                                                                                                                                                                                • dns-server/misc.ycp
                                                                                                                                                                                                                • dns-server/options.ycp
                                                                                                                                                                                                                • dns-server/wizards.ycp

                                                                                                                                                                                                                71. DontShowAgain

                                                                                                                                                                                                                Handling "Don Not Show This Dialog Again"

                                                                                                                                                                                                                71.1. Authors

                                                                                                                                                                                                                • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                71.2. Summary of Module Globals

                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                  71.3. Global Functions

                                                                                                                                                                                                                  71.3.1. GetCurrentConfigurationMap

                                                                                                                                                                                                                  Returns the current configuration map

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • map <string, map <string, map <string, any> > > - with the current configuration

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.3.2. GetDefaultReturn

                                                                                                                                                                                                                  Return the default return value for question that should not be shown again

                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                  • map <string, string> params

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • any - default return value

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.3.3. GetShowQuestionAgain

                                                                                                                                                                                                                  Returns whether the question should be shown again

                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                  • map <string, string> params

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • boolean - it should be shown

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.3.4. RemoveShowQuestionAgain

                                                                                                                                                                                                                  Removes one entry defined with map params

                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                  • map <string, string> params

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • boolean - if success

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.3.5. SetDefaultReturn

                                                                                                                                                                                                                  Sets the default return value for the question that should not be shown

                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                  • map <string, string> params

                                                                                                                                                                                                                  • any default_return

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • boolean - if success

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.3.6. SetShowQuestionAgain

                                                                                                                                                                                                                  Sets and stores whether the question should be shown again. If it should be, the result is not stored since the 'show again' is the default value.

                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                  • map <string, string> params

                                                                                                                                                                                                                  • boolean new_value

                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                  • boolean - if success

                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                  • current_configuration

                                                                                                                                                                                                                  71.4. Global Variables

                                                                                                                                                                                                                  71.5. Module Requirements

                                                                                                                                                                                                                  71.5.1. Module Imports

                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                  • FileUtils

                                                                                                                                                                                                                  71.5.2. Module Includes

                                                                                                                                                                                                                    72. Drbd

                                                                                                                                                                                                                    72.1. Authors

                                                                                                                                                                                                                      72.2. Summary of Module Globals

                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                          72.3. Global Functions

                                                                                                                                                                                                                          72.4. Global Variables

                                                                                                                                                                                                                          72.5. Module Requirements

                                                                                                                                                                                                                          72.5.1. Module Imports

                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                          • PackageSystem
                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                          72.5.2. Module Includes

                                                                                                                                                                                                                            73. DualMultiSelectionBox

                                                                                                                                                                                                                            Expert Partitioner

                                                                                                                                                                                                                            73.1. Authors

                                                                                                                                                                                                                            • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                            • The items must have the `id() as their first element.

                                                                                                                                                                                                                            73.2. Summary of Module Globals

                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                73.3. Global Functions

                                                                                                                                                                                                                                73.4. Global Variables

                                                                                                                                                                                                                                73.5. Module Requirements

                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                74. Dump

                                                                                                                                                                                                                                Creating dump devices for S/390

                                                                                                                                                                                                                                74.1. Authors

                                                                                                                                                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                74.2. Summary of Module Globals

                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                • Abort - Abort function

                                                                                                                                                                                                                                • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                • Available - Is this kind of disk controller available?

                                                                                                                                                                                                                                • AvailableDisks - Create a List of available Disks

                                                                                                                                                                                                                                • Export - Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                • FormatDisk - Format a disk as DUMP device

                                                                                                                                                                                                                                • Import - Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                • Modified - Prototypes

                                                                                                                                                                                                                                • Modified - Data was modified?

                                                                                                                                                                                                                                • Read - Read all controller settings

                                                                                                                                                                                                                                • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                • Write - Write all controller settings

                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                • proposal_valid -

                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                74.3. Global Functions

                                                                                                                                                                                                                                74.3.1. Abort

                                                                                                                                                                                                                                Abort function

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - blah blah lahjk

                                                                                                                                                                                                                                74.3.2. AutoPackages

                                                                                                                                                                                                                                Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • map - with 2 lists.

                                                                                                                                                                                                                                74.3.3. Available

                                                                                                                                                                                                                                Is this kind of disk controller available?

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - true if it is

                                                                                                                                                                                                                                74.3.4. AvailableDisks

                                                                                                                                                                                                                                Create a List of available Disks

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • list<string> - of disks

                                                                                                                                                                                                                                74.3.5. Export

                                                                                                                                                                                                                                Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                74.3.6. FormatDisk

                                                                                                                                                                                                                                Format a disk as DUMP device

                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                • string dev

                                                                                                                                                                                                                                • boolean force

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                74.3.7. Import

                                                                                                                                                                                                                                Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                74.3.8. Modified

                                                                                                                                                                                                                                Prototypes

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                74.3.9. Modified

                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                74.3.10. Read

                                                                                                                                                                                                                                Read all controller settings

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                74.3.11. Summary

                                                                                                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • list - summary of the current configuration

                                                                                                                                                                                                                                74.3.12. Write

                                                                                                                                                                                                                                Write all controller settings

                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                74.4. Global Variables

                                                                                                                                                                                                                                74.4.1. modified

                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                74.4.2. proposal_valid

                                                                                                                                                                                                                                74.4.3. write_only

                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                74.5. Module Requirements

                                                                                                                                                                                                                                74.5.1. Module Imports

                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                • Stage
                                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                                74.5.2. Module Includes

                                                                                                                                                                                                                                  75. EdirUtilsLUM

                                                                                                                                                                                                                                  Edir utility routines

                                                                                                                                                                                                                                  75.1. Authors

                                                                                                                                                                                                                                  • Stephen T. Bunch <sbunch@novell.com>

                                                                                                                                                                                                                                  75.2. Summary of Module Globals

                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                    75.3. Global Functions

                                                                                                                                                                                                                                    75.3.1. DoesEdirectoryTreeExist

                                                                                                                                                                                                                                    Check if tree exists

                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                    • string treeName

                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                    75.3.2. GetLeafNameLDAP

                                                                                                                                                                                                                                    GetLeafNameLDAP(string ldapName)

                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                    • string ldapName

                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                    75.3.3. GetLeafNameNDS

                                                                                                                                                                                                                                    GetLeafNameNDS(string ndsName)

                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                    • string ndsName

                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                    75.3.4. GetTreeName

                                                                                                                                                                                                                                    GetTreeName

                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                    • string ip

                                                                                                                                                                                                                                    • integer nport

                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                    75.4. Global Variables

                                                                                                                                                                                                                                    75.5. Module Requirements

                                                                                                                                                                                                                                    75.5.1. Module Imports

                                                                                                                                                                                                                                    • NovellUtilsLUM
                                                                                                                                                                                                                                    • NovellValidatorsLUM
                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                    • Report

                                                                                                                                                                                                                                    75.5.2. Module Includes

                                                                                                                                                                                                                                      76. Encoding

                                                                                                                                                                                                                                      Provide the encoding stuff

                                                                                                                                                                                                                                      76.1. Authors

                                                                                                                                                                                                                                      • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                      76.2. Summary of Module Globals

                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                      76.3. Global Functions

                                                                                                                                                                                                                                      76.3.1. Encoding

                                                                                                                                                                                                                                      Constructor does nothing in initial mode restores console encoding from /etc/sysconfig in normal mode

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                      76.3.2. GetCodePage

                                                                                                                                                                                                                                      Get Code Page

                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                      • string enc

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                      76.3.3. GetEncLang

                                                                                                                                                                                                                                      Get Encoding Language

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • string - Language

                                                                                                                                                                                                                                      76.3.4. GetUtf8Lang

                                                                                                                                                                                                                                      Get UTF8 Language

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                      76.3.5. Restore

                                                                                                                                                                                                                                      Restore data to system

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • string - console encoding

                                                                                                                                                                                                                                      76.3.6. SetEncLang

                                                                                                                                                                                                                                      Set Encoding Language

                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                      • string new_lang

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                      76.3.7. SetUtf8Lang

                                                                                                                                                                                                                                      Set UTF8 Language

                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                      • boolean new_utf8

                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                      76.4. Global Variables

                                                                                                                                                                                                                                      76.4.1. console

                                                                                                                                                                                                                                      Current (ISO) encoding

                                                                                                                                                                                                                                      76.5. Module Requirements

                                                                                                                                                                                                                                      76.5.1. Module Imports

                                                                                                                                                                                                                                      • Stage

                                                                                                                                                                                                                                      76.5.2. Module Includes

                                                                                                                                                                                                                                        77. FTP

                                                                                                                                                                                                                                        Handle FTP Requests

                                                                                                                                                                                                                                        77.1. Authors

                                                                                                                                                                                                                                        • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                        77.2. Summary of Module Globals

                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                        • Dir - List FTP directory

                                                                                                                                                                                                                                        • Get - Send a get request

                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                          77.3. Global Functions

                                                                                                                                                                                                                                          77.3.1. Dir

                                                                                                                                                                                                                                          List FTP directory

                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                          • string url

                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                          • list

                                                                                                                                                                                                                                          77.3.2. Get

                                                                                                                                                                                                                                          Send a get request

                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                          • string url

                                                                                                                                                                                                                                          • string output

                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                          • map - Reponse map with HTTP code and transfer size and time

                                                                                                                                                                                                                                          77.4. Global Variables

                                                                                                                                                                                                                                          77.5. Module Requirements

                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                          78. Fax

                                                                                                                                                                                                                                          Configuration of a ISDN Fax machine

                                                                                                                                                                                                                                          78.1. Authors

                                                                                                                                                                                                                                          • Karsten Keil <kkeil@suse.de>

                                                                                                                                                                                                                                          78.2. Summary of Module Globals

                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                          • Read - Read config settings

                                                                                                                                                                                                                                          • Write - Write fax settings and apply changes

                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                          • aconfig - All Fax machine configured user data

                                                                                                                                                                                                                                          • gconfig - All Fax machine global settings

                                                                                                                                                                                                                                          • modified - Data was modified?

                                                                                                                                                                                                                                          • users - List of available users

                                                                                                                                                                                                                                          78.3. Global Functions

                                                                                                                                                                                                                                          78.3.1. Read

                                                                                                                                                                                                                                          Read config settings

                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                          • boolean - true if success

                                                                                                                                                                                                                                          78.3.2. Write

                                                                                                                                                                                                                                          Write fax settings and apply changes

                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                          • boolean - true if success

                                                                                                                                                                                                                                          78.4. Global Variables

                                                                                                                                                                                                                                          78.4.1. aconfig

                                                                                                                                                                                                                                          All Fax machine configured user data

                                                                                                                                                                                                                                          78.4.2. gconfig

                                                                                                                                                                                                                                          All Fax machine global settings

                                                                                                                                                                                                                                          78.4.3. modified

                                                                                                                                                                                                                                          Data was modified?

                                                                                                                                                                                                                                          78.4.4. users

                                                                                                                                                                                                                                          List of available users

                                                                                                                                                                                                                                          78.5. Module Requirements

                                                                                                                                                                                                                                          78.5.1. Module Imports

                                                                                                                                                                                                                                          • Package
                                                                                                                                                                                                                                          • Users
                                                                                                                                                                                                                                          • UsersCache

                                                                                                                                                                                                                                          78.5.2. Module Includes

                                                                                                                                                                                                                                            79. FileChanges

                                                                                                                                                                                                                                            Detect if a configuratil file was changed

                                                                                                                                                                                                                                            79.1. Authors

                                                                                                                                                                                                                                            • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                            • Support routines for detecting changes of configuration files being done

                                                                                                                                                                                                                                            • externally (not by YaST) to prevent the changes from being lost because

                                                                                                                                                                                                                                            • of YaST not handling the configuration files correctly (eg. removing

                                                                                                                                                                                                                                            • comments in some cases, changing order of options,...)

                                                                                                                                                                                                                                            • Warns user if such change is detected.

                                                                                                                                                                                                                                            • Usage:

                                                                                                                                                                                                                                            • Before reading the configuration file:

                                                                                                                                                                                                                                            • call boolean CheckFiles (list<string>) with all files. If any of them

                                                                                                                                                                                                                                            • is detected to be changed, YaST asks a popup for you.

                                                                                                                                                                                                                                            • alternatively use boolean FileChanged (string) for each file (does not

                                                                                                                                                                                                                                            • ask any question, immediatelly returns status of the file

                                                                                                                                                                                                                                            • After writing the configuraiton file:

                                                                                                                                                                                                                                            • call void StoreFileCheckSum (string) for each file to store recent

                                                                                                                                                                                                                                            • checksum. YaST will use this checksum next time checking.

                                                                                                                                                                                                                                            79.2. Summary of Module Globals

                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                            • CheckFiles - Check files if any of them were changed Issue a question whether to continue if some were chaned

                                                                                                                                                                                                                                            • FileChanged - Check if a file was modified externally (without YaST)

                                                                                                                                                                                                                                            • StoreFileCheckSum - Store checksum of a file to the store

                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                              79.3. Global Functions

                                                                                                                                                                                                                                              79.3.1. CheckFiles

                                                                                                                                                                                                                                              Check files if any of them were changed Issue a question whether to continue if some were chaned

                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                              • list<string> files

                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                              • boolean - true if either none was changed or user agreed to continue

                                                                                                                                                                                                                                              79.3.2. FileChanged

                                                                                                                                                                                                                                              Check if a file was modified externally (without YaST)

                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                              • boolean - true if was changed externally

                                                                                                                                                                                                                                              79.3.3. StoreFileCheckSum

                                                                                                                                                                                                                                              Store checksum of a file to the store

                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                              79.4. Global Variables

                                                                                                                                                                                                                                              79.5. Module Requirements

                                                                                                                                                                                                                                              79.5.1. Module Imports

                                                                                                                                                                                                                                              • Directory
                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                              • Popup

                                                                                                                                                                                                                                              79.5.2. Module Includes

                                                                                                                                                                                                                                                80. FileSystems

                                                                                                                                                                                                                                                80.1. Authors

                                                                                                                                                                                                                                                • Johannes Buchhold (jbuch@suse.de)

                                                                                                                                                                                                                                                • Purpose:

                                                                                                                                                                                                                                                • These module contains the supported filesystems and their settings.

                                                                                                                                                                                                                                                80.2. Summary of Module Globals

                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                  80.3. Global Functions

                                                                                                                                                                                                                                                  80.3.1. GetAllFileSystems

                                                                                                                                                                                                                                                  Filesystem Definitions

                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                  • boolean add_swap

                                                                                                                                                                                                                                                  • boolean add_pseudo

                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                  • map<symbol, map<symbol, any> > - map with all supported filesystems

                                                                                                                                                                                                                                                  80.3.2. GetMountString

                                                                                                                                                                                                                                                  Return the mount option for each used_fs (-t)

                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                  • symbol used_fs

                                                                                                                                                                                                                                                  • string defaultv

                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                  80.4. Global Variables

                                                                                                                                                                                                                                                  80.5. Module Requirements

                                                                                                                                                                                                                                                  80.5.1. Module Imports

                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                  • Encoding
                                                                                                                                                                                                                                                  • LibStorage
                                                                                                                                                                                                                                                  • LibStorage::ContVolInfo
                                                                                                                                                                                                                                                  • LibStorage::DiskInfo
                                                                                                                                                                                                                                                  • LibStorage::FsCapabilities
                                                                                                                                                                                                                                                  • LibStorage::StorageInterface
                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                  • Partitions
                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                  • String

                                                                                                                                                                                                                                                  80.5.2. Module Includes

                                                                                                                                                                                                                                                    81. FileUtils

                                                                                                                                                                                                                                                    Module for getting information about files and directories. Their types and sizes and functions for checking, creating and removing them.

                                                                                                                                                                                                                                                    81.1. Authors

                                                                                                                                                                                                                                                    • Lukas Ocilka <lukas.ocilka@suse.cz>

                                                                                                                                                                                                                                                    81.2. Summary of Module Globals

                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                    • CheckAndCreatePath - Checks whether the path (directory) exists and return a boolean value whether everything is OK or user accepted the behavior as despite some errors. If the directory doesn't exist, it offers to create it (and eventually creates it).

                                                                                                                                                                                                                                                    • Exists - Function which determines if the requested file/directory exists.

                                                                                                                                                                                                                                                    • GetFileRealType - Function returns the real type of requested file/directory. If the file is a link to any object, "link" is returned.

                                                                                                                                                                                                                                                    • GetFileType - Function returns the type of requested file/directory. If the file is a link to any object, the object's type is returned.

                                                                                                                                                                                                                                                    • GetOwnerGroupID - Function which determines the owner's group ID of requested file/directory.

                                                                                                                                                                                                                                                    • GetOwnerUserID - Function which determines the owner's user ID of requested file/directory.

                                                                                                                                                                                                                                                    • GetSize - Function which returns the size of requested file/directory.

                                                                                                                                                                                                                                                    • IsBlock - Function which determines if the requested file/directory is a block file (device) or link to a block device.

                                                                                                                                                                                                                                                    • IsCharacterDevice - Function which determines if the requested file/directory is a character device or link to a character device.

                                                                                                                                                                                                                                                    • IsDirectory - Function which determines if the requested file/directory is a directory or it is a link to a directory.

                                                                                                                                                                                                                                                    • IsFifo - Function which determines if the requested file/directory is a fifo or link to a fifo.

                                                                                                                                                                                                                                                    • IsFile - Function which determines if the requested file/directory is a regular file or it is a link to a regular file.

                                                                                                                                                                                                                                                    • IsLink - Function which determines if the requested file/directory is a link.

                                                                                                                                                                                                                                                    • IsSocket - Function which determines if the requested file/directory is a socket or link to a socket.

                                                                                                                                                                                                                                                    • MD5sum - Function return the MD5 sum of the file.

                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                      81.3. Global Functions

                                                                                                                                                                                                                                                      81.3.1. CheckAndCreatePath

                                                                                                                                                                                                                                                      Checks whether the path (directory) exists and return a boolean value whether everything is OK or user accepted the behavior as despite some errors. If the directory doesn't exist, it offers to create it (and eventually creates it).

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string pathvalue

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - whether everything was OK or whether user decided to ignore eventual errors

                                                                                                                                                                                                                                                      81.3.2. Exists

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory exists.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if exists

                                                                                                                                                                                                                                                      Example 4. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::Exists ("/tmp") -> true
                                                                                                                                                                                                                                                      	FileUtils::Exists ("/tmp/somefile") -> false


                                                                                                                                                                                                                                                      81.3.3. GetFileRealType

                                                                                                                                                                                                                                                      Function returns the real type of requested file/directory. If the file is a link to any object, "link" is returned.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • string - file type (directory|regular|block|fifo|link|socket|chr_device), nil if doesn't exist

                                                                                                                                                                                                                                                      Example 5. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::GetFileRealType ("/var") -> "directory"
                                                                                                                                                                                                                                                      	FileUtils::GetFileRealType ("/etc/passwd") -> "file"
                                                                                                                                                                                                                                                      	FileUtils::GetFileRealType ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.4. GetFileType

                                                                                                                                                                                                                                                      Function returns the type of requested file/directory. If the file is a link to any object, the object's type is returned.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • string - fle type (directory|regular|block|fifo|link|socket|chr_device), nil if doesn't exist

                                                                                                                                                                                                                                                      81.3.5. GetOwnerGroupID

                                                                                                                                                                                                                                                      Function which determines the owner's group ID of requested file/directory.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • integer - GID, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 6. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::GetOwnerGroupID ("/etc/passwd") -> 0
                                                                                                                                                                                                                                                      	FileUtils::GetOwnerGroupID ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.6. GetOwnerUserID

                                                                                                                                                                                                                                                      Function which determines the owner's user ID of requested file/directory.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • integer - UID, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 7. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::GetOwnerUserID ("/etc/passwd") -> 0
                                                                                                                                                                                                                                                      	FileUtils::GetOwnerUserID ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.7. GetSize

                                                                                                                                                                                                                                                      Function which returns the size of requested file/directory.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • integer - file size, -1 if doesn't exist

                                                                                                                                                                                                                                                      Example 8. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::GetSize ("/var/log/YaST2") -> 12348
                                                                                                                                                                                                                                                      	FileUtils::GetSize ("/does-not-exist") -> -1


                                                                                                                                                                                                                                                      81.3.8. IsBlock

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a block file (device) or link to a block device.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a block file, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 9. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::IsBlock ("/var") -> false
                                                                                                                                                                                                                                                      	FileUtils::IsBlock ("/dev/sda2") -> true
                                                                                                                                                                                                                                                      	FileUtils::IsBlock ("/dev/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.9. IsCharacterDevice

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a character device or link to a character device.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a charcater device, nil if doesn't exist

                                                                                                                                                                                                                                                      81.3.10. IsDirectory

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a directory or it is a link to a directory.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a directory, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 10. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::IsDirectory ("/var") -> true
                                                                                                                                                                                                                                                      	FileUtils::IsDirectory ("/var/log/messages") -> false
                                                                                                                                                                                                                                                      	FileUtils::IsDirectory ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.11. IsFifo

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a fifo or link to a fifo.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a fifo, nil if doesn't exist

                                                                                                                                                                                                                                                      81.3.12. IsFile

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a regular file or it is a link to a regular file.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a regular file, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 11. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::IsFile ("/var") -> false
                                                                                                                                                                                                                                                      	FileUtils::IsFile ("/var/log/messages") -> true
                                                                                                                                                                                                                                                      	FileUtils::IsFile ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.3.13. IsLink

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a link.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a link, nil if doesn't exist

                                                                                                                                                                                                                                                      81.3.14. IsSocket

                                                                                                                                                                                                                                                      Function which determines if the requested file/directory is a socket or link to a socket.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • boolean - true if it is a socket, nil if doesn't exist

                                                                                                                                                                                                                                                      81.3.15. MD5sum

                                                                                                                                                                                                                                                      Function return the MD5 sum of the file.

                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                      • string - MD5 sum of the file, nil if doesn't exist

                                                                                                                                                                                                                                                      Example 12. 

                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                      	FileUtils::MD5sum ("/etc/passwd") -> "74855f6ac9bf728fccec4792d1dba828"
                                                                                                                                                                                                                                                      	FileUtils::MD5sum ("/does-not-exist") -> nil


                                                                                                                                                                                                                                                      81.4. Global Variables

                                                                                                                                                                                                                                                      81.5. Module Requirements

                                                                                                                                                                                                                                                      81.5.1. Module Imports

                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                      • SCR
                                                                                                                                                                                                                                                      • String

                                                                                                                                                                                                                                                      81.5.2. Module Includes

                                                                                                                                                                                                                                                        82. FingerprintReader

                                                                                                                                                                                                                                                        82.1. Authors

                                                                                                                                                                                                                                                          82.2. Summary of Module Globals

                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                          • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                          • CryptedHomesEnabled - If pam_mount is enabled, pam_fp cannot be used (bnc#390810)

                                                                                                                                                                                                                                                          • Export - Dump the fingerprint-reader settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                          • Import - Get all fingerprint-reader settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                          • Read - Read all fingerprint-reader settings

                                                                                                                                                                                                                                                          • ReadFingerprintReaderDevices - Get the list of fingerprint readers

                                                                                                                                                                                                                                                          • ShortSummary - Create a short textual summary

                                                                                                                                                                                                                                                          • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                          • UpdatedArchPackages - Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                          • Write - Write all fingerprint-reader settings

                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                          • import_dir - Directory with fingerprint files that should be imported

                                                                                                                                                                                                                                                          • modified - Data was modified?

                                                                                                                                                                                                                                                          • required_packages - Required packages for this module to operate

                                                                                                                                                                                                                                                          • use_pam - if Fingerprint Reader authentication is enabled

                                                                                                                                                                                                                                                          • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                          82.3. Global Functions

                                                                                                                                                                                                                                                          82.3.1. AutoPackages

                                                                                                                                                                                                                                                          Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • map - with 2 lists.

                                                                                                                                                                                                                                                          82.3.2. CryptedHomesEnabled

                                                                                                                                                                                                                                                          If pam_mount is enabled, pam_fp cannot be used (bnc#390810)

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                          82.3.3. Export

                                                                                                                                                                                                                                                          Dump the fingerprint-reader settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                          82.3.4. Import

                                                                                                                                                                                                                                                          Get all fingerprint-reader settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • boolean - True on success

                                                                                                                                                                                                                                                          82.3.5. Read

                                                                                                                                                                                                                                                          Read all fingerprint-reader settings

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                          82.3.6. ReadFingerprintReaderDevices

                                                                                                                                                                                                                                                          Get the list of fingerprint readers

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • list

                                                                                                                                                                                                                                                          82.3.7. ShortSummary

                                                                                                                                                                                                                                                          Create a short textual summary

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • string - summary of the current configuration

                                                                                                                                                                                                                                                          82.3.8. Summary

                                                                                                                                                                                                                                                          Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • list - summary of the current configuration

                                                                                                                                                                                                                                                          82.3.9. UpdatedArchPackages

                                                                                                                                                                                                                                                          Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                          • list<string> packages

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • list<string>

                                                                                                                                                                                                                                                          82.3.10. Write

                                                                                                                                                                                                                                                          Write all fingerprint-reader settings

                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                          82.4. Global Variables

                                                                                                                                                                                                                                                          82.4.1. import_dir

                                                                                                                                                                                                                                                          Directory with fingerprint files that should be imported

                                                                                                                                                                                                                                                          82.4.2. modified

                                                                                                                                                                                                                                                          Data was modified?

                                                                                                                                                                                                                                                          82.4.3. required_packages

                                                                                                                                                                                                                                                          Required packages for this module to operate

                                                                                                                                                                                                                                                          82.4.4. use_pam

                                                                                                                                                                                                                                                          if Fingerprint Reader authentication is enabled

                                                                                                                                                                                                                                                          82.4.5. write_only

                                                                                                                                                                                                                                                          Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                          82.5. Module Requirements

                                                                                                                                                                                                                                                          82.5.1. Module Imports

                                                                                                                                                                                                                                                          • Arch
                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                          • Pam
                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                          82.5.2. Module Includes

                                                                                                                                                                                                                                                            83. Firstboot

                                                                                                                                                                                                                                                            Firstboot settings, input and output functions

                                                                                                                                                                                                                                                            83.1. Authors

                                                                                                                                                                                                                                                            • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                            83.2. Summary of Module Globals

                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                            • Export - Export firstboot settigs defined by autoyast

                                                                                                                                                                                                                                                            • Import - Import firstboot settigs defined by autoyast

                                                                                                                                                                                                                                                            • Summary - Summary() returns html formated configuration summary

                                                                                                                                                                                                                                                            • Write - Write firstboot settings

                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                              83.3. Global Functions

                                                                                                                                                                                                                                                              83.3.1. Export

                                                                                                                                                                                                                                                              Export firstboot settigs defined by autoyast

                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                              • map

                                                                                                                                                                                                                                                              83.3.2. Import

                                                                                                                                                                                                                                                              Import firstboot settigs defined by autoyast

                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                              83.3.3. Summary

                                                                                                                                                                                                                                                              Summary() returns html formated configuration summary

                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                              • string - summary

                                                                                                                                                                                                                                                              83.3.4. Write

                                                                                                                                                                                                                                                              Write firstboot settings

                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                              83.4. Global Variables

                                                                                                                                                                                                                                                              83.5. Module Requirements

                                                                                                                                                                                                                                                              83.5.1. Module Imports

                                                                                                                                                                                                                                                              • Directory
                                                                                                                                                                                                                                                              • Internet
                                                                                                                                                                                                                                                              • Misc
                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                              • NetworkInterfaces
                                                                                                                                                                                                                                                              • ProductControl
                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                              • Summary

                                                                                                                                                                                                                                                              83.5.2. Module Includes

                                                                                                                                                                                                                                                                84. FtpServer

                                                                                                                                                                                                                                                                FtpServer settings, input and output functions

                                                                                                                                                                                                                                                                84.1. Authors

                                                                                                                                                                                                                                                                • Jozef Uhliarik <juhliarik@suse.cz>

                                                                                                                                                                                                                                                                84.2. Summary of Module Globals

                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                • Abort - Returns a confirmation popup dialog whether user wants to really abort.

                                                                                                                                                                                                                                                                • Export - Dump the FtpServer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                • GetModified - Returns whether the configuration has been modified.

                                                                                                                                                                                                                                                                • Import - Get all FtpServer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                • InitDaemon - Set which daemon will be configured (For use by autoinstallation.)

                                                                                                                                                                                                                                                                • Modified - Prototypes

                                                                                                                                                                                                                                                                • Modified - Data was modified?

                                                                                                                                                                                                                                                                • OptionsSummary - Create unsorted list of options

                                                                                                                                                                                                                                                                • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                • PollAbort - Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                                                                                                                                                                                                                                                                • Read - Read all FtpServer settings

                                                                                                                                                                                                                                                                • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                • ValueUIEdit - read value from PURE_EDIT_SETTINGS

                                                                                                                                                                                                                                                                • Write - Write all FtpServer settings

                                                                                                                                                                                                                                                                • WriteSettings - Write current configuration

                                                                                                                                                                                                                                                                • WriteToEditMap - Write value from UI to temporary structure

                                                                                                                                                                                                                                                                • WriteUpload - Ask for creation upload directory It is necessary if user want to allow uploading for anonymous

                                                                                                                                                                                                                                                                • WriteXinetd - Write current configuration

                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                • DEFAULT_CONFIG - map of deafult values for options in UI

                                                                                                                                                                                                                                                                • EDIT_SETTINGS - map <string, string > of vsftpd settings

                                                                                                                                                                                                                                                                • PURE_SETTINGS - map <string, string > of pure-ftpd settings

                                                                                                                                                                                                                                                                • UI_keys - list of keys from map DEFAULT_CONFIG

                                                                                                                                                                                                                                                                • VS_SETTINGS - map <string, string > of vsftpd settings

                                                                                                                                                                                                                                                                • anon_homedir - variable signifies home dir for anonymous user

                                                                                                                                                                                                                                                                • anon_uid - variable signifies uid for anonymous user

                                                                                                                                                                                                                                                                • change_permissions - variable signifies if user choose change permissions for home dir for anonymous connections with allowed upload

                                                                                                                                                                                                                                                                • create_upload_dir - variable signifies if it is create upload dir only for vsftpd and anonymous connections with allowed upload

                                                                                                                                                                                                                                                                • ftps -

                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                • proposal_valid - general variable for proposal

                                                                                                                                                                                                                                                                • pure_ftp_allowed_permissios_upload - variable signifies if upload dir for anonymous has good permissions it is only for pure-ftpd

                                                                                                                                                                                                                                                                • pure_ftp_xinetd_running - variable signifies if daemon is running via xinetd

                                                                                                                                                                                                                                                                • pure_ftpd_xinet_conf - list includes xinetd server_args for pure-ftpd

                                                                                                                                                                                                                                                                • pureftpd_installed - variable signifies if pure-ftpd is installed and

                                                                                                                                                                                                                                                                • pureftpd_xined_id - variable signifies if pure-ftpd is installed and in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

                                                                                                                                                                                                                                                                • start_xinetd - variable signifies if daemon will be started via xinetd

                                                                                                                                                                                                                                                                • stop_daemon_xinetd - variable signifies if daemon will be stoped in xinetd

                                                                                                                                                                                                                                                                • upload_good_permission - variable signifies if upload dir has good permissions only for vsftpd and anonymous connections with allowed upload

                                                                                                                                                                                                                                                                • vsftp_xinetd_running - variable signifies if daemon is running via xinetd

                                                                                                                                                                                                                                                                • vsftpd_edit - variable signifies if vsftpd is selected and edited via ftp-server (YaST module) global boolean variable

                                                                                                                                                                                                                                                                • vsftpd_installed - variable signifies if vsftpd is installed and

                                                                                                                                                                                                                                                                • vsftpd_xined_id - variable signifies position vsftpd record in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

                                                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                84.3. Global Functions

                                                                                                                                                                                                                                                                84.3.1. Abort

                                                                                                                                                                                                                                                                Returns a confirmation popup dialog whether user wants to really abort.

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - result of Popup::ReallyAbort(GetModified()

                                                                                                                                                                                                                                                                84.3.2. Export

                                                                                                                                                                                                                                                                Dump the FtpServer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                84.3.3. GetModified

                                                                                                                                                                                                                                                                Returns whether the configuration has been modified.

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - modified

                                                                                                                                                                                                                                                                84.3.4. Import

                                                                                                                                                                                                                                                                Get all FtpServer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                84.3.5. InitDaemon

                                                                                                                                                                                                                                                                Set which daemon will be configured (For use by autoinstallation.)

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                84.3.6. Modified

                                                                                                                                                                                                                                                                Prototypes

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                84.3.7. Modified

                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                                                84.3.8. OptionsSummary

                                                                                                                                                                                                                                                                Create unsorted list of options

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • string - Returnes string with RichText-formated list

                                                                                                                                                                                                                                                                84.3.9. Overview

                                                                                                                                                                                                                                                                Create an overview table with all configured cards

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • list - table items

                                                                                                                                                                                                                                                                84.3.10. PollAbort

                                                                                                                                                                                                                                                                Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - true if abort confirmed

                                                                                                                                                                                                                                                                84.3.11. Read

                                                                                                                                                                                                                                                                Read all FtpServer settings

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                84.3.12. Summary

                                                                                                                                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • string - summary of the current configuration

                                                                                                                                                                                                                                                                84.3.13. ValueUIEdit

                                                                                                                                                                                                                                                                read value from PURE_EDIT_SETTINGS

                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                • string key

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • string - value of key from edit map

                                                                                                                                                                                                                                                                84.3.14. Write

                                                                                                                                                                                                                                                                Write all FtpServer settings

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                84.3.15. WriteSettings

                                                                                                                                                                                                                                                                Write current configuration

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - successfull

                                                                                                                                                                                                                                                                84.3.16. WriteToEditMap

                                                                                                                                                                                                                                                                Write value from UI to temporary structure

                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                • string key

                                                                                                                                                                                                                                                                • string value

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - successfull

                                                                                                                                                                                                                                                                84.3.17. WriteUpload

                                                                                                                                                                                                                                                                Ask for creation upload directory It is necessary if user want to allow uploading for anonymous

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - result of function (true/false)

                                                                                                                                                                                                                                                                84.3.18. WriteXinetd

                                                                                                                                                                                                                                                                Write current configuration

                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                • boolean - result of function (true/false)

                                                                                                                                                                                                                                                                84.4. Global Variables

                                                                                                                                                                                                                                                                84.4.1. DEFAULT_CONFIG

                                                                                                                                                                                                                                                                map of deafult values for options in UI

                                                                                                                                                                                                                                                                84.4.2. EDIT_SETTINGS

                                                                                                                                                                                                                                                                map <string, string > of vsftpd settings

                                                                                                                                                                                                                                                                84.4.3. PURE_SETTINGS

                                                                                                                                                                                                                                                                map <string, string > of pure-ftpd settings

                                                                                                                                                                                                                                                                84.4.4. UI_keys

                                                                                                                                                                                                                                                                list of keys from map DEFAULT_CONFIG

                                                                                                                                                                                                                                                                84.4.5. VS_SETTINGS

                                                                                                                                                                                                                                                                map <string, string > of vsftpd settings

                                                                                                                                                                                                                                                                84.4.6. anon_homedir

                                                                                                                                                                                                                                                                variable signifies home dir for anonymous user

                                                                                                                                                                                                                                                                84.4.7. anon_uid

                                                                                                                                                                                                                                                                variable signifies uid for anonymous user

                                                                                                                                                                                                                                                                84.4.8. change_permissions

                                                                                                                                                                                                                                                                variable signifies if user choose change permissions for home dir for anonymous connections with allowed upload

                                                                                                                                                                                                                                                                84.4.9. create_upload_dir

                                                                                                                                                                                                                                                                variable signifies if it is create upload dir only for vsftpd and anonymous connections with allowed upload

                                                                                                                                                                                                                                                                84.4.10. ftps

                                                                                                                                                                                                                                                                84.4.11. modified

                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                84.4.12. proposal_valid

                                                                                                                                                                                                                                                                general variable for proposal

                                                                                                                                                                                                                                                                84.4.13. pure_ftp_allowed_permissios_upload

                                                                                                                                                                                                                                                                variable signifies if upload dir for anonymous has good permissions it is only for pure-ftpd

                                                                                                                                                                                                                                                                84.4.14. pure_ftp_xinetd_running

                                                                                                                                                                                                                                                                variable signifies if daemon is running via xinetd

                                                                                                                                                                                                                                                                84.4.15. pure_ftpd_xinet_conf

                                                                                                                                                                                                                                                                list includes xinetd server_args for pure-ftpd

                                                                                                                                                                                                                                                                84.4.16. pureftpd_installed

                                                                                                                                                                                                                                                                variable signifies if pure-ftpd is installed and

                                                                                                                                                                                                                                                                84.4.17. pureftpd_xined_id

                                                                                                                                                                                                                                                                variable signifies if pure-ftpd is installed and in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

                                                                                                                                                                                                                                                                84.4.18. start_xinetd

                                                                                                                                                                                                                                                                variable signifies if daemon will be started via xinetd

                                                                                                                                                                                                                                                                84.4.19. stop_daemon_xinetd

                                                                                                                                                                                                                                                                variable signifies if daemon will be stoped in xinetd

                                                                                                                                                                                                                                                                84.4.20. upload_good_permission

                                                                                                                                                                                                                                                                variable signifies if upload dir has good permissions only for vsftpd and anonymous connections with allowed upload

                                                                                                                                                                                                                                                                84.4.21. vsftp_xinetd_running

                                                                                                                                                                                                                                                                variable signifies if daemon is running via xinetd

                                                                                                                                                                                                                                                                84.4.22. vsftpd_edit

                                                                                                                                                                                                                                                                variable signifies if vsftpd is selected and edited via ftp-server (YaST module) global boolean variable

                                                                                                                                                                                                                                                                84.4.23. vsftpd_installed

                                                                                                                                                                                                                                                                variable signifies if vsftpd is installed and

                                                                                                                                                                                                                                                                84.4.24. vsftpd_xined_id

                                                                                                                                                                                                                                                                variable signifies position vsftpd record in structur Inetd::netd_conf -1 init value before calling Inetd::Read()

                                                                                                                                                                                                                                                                84.4.25. write_only

                                                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                84.5. Module Requirements

                                                                                                                                                                                                                                                                84.5.1. Module Imports

                                                                                                                                                                                                                                                                • CommandLine
                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                • Package
                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                • PortAliases
                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                                                                • SuSEFirewallServices
                                                                                                                                                                                                                                                                • Summary
                                                                                                                                                                                                                                                                • Users

                                                                                                                                                                                                                                                                84.5.2. Module Includes

                                                                                                                                                                                                                                                                • ftp-server/write_load.ycp

                                                                                                                                                                                                                                                                85. GPG

                                                                                                                                                                                                                                                                A wrapper for gpg binary

                                                                                                                                                                                                                                                                85.1. Authors

                                                                                                                                                                                                                                                                • Ladislav SlezĂĄk <lslezak@suse.cz>

                                                                                                                                                                                                                                                                85.2. Summary of Module Globals

                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                • CreateKey - Create a new gpg key. Executes 'gpg --gen-key' in an xterm window (in the QT UI) or in the terminal window (in the ncurses UI).

                                                                                                                                                                                                                                                                • ExportAsciiPublicKey - Export a public gpg key in ACSII armored file.

                                                                                                                                                                                                                                                                • ExportPublicKey - Export a public gpg key in binary format.

                                                                                                                                                                                                                                                                • Init - (Re)initialize the module, the cache is invalidated if the home directory is changed.

                                                                                                                                                                                                                                                                • PrivateKeys - Return list of the private keys in the keyring.

                                                                                                                                                                                                                                                                • PublicKeys - Return list of the public keys in the keyring.

                                                                                                                                                                                                                                                                • SignAsciiDetached - Sign a file. The ASCII armored signature is stored in file with .asc suffix

                                                                                                                                                                                                                                                                • SignDetached - Sign a file. The binary signature is stored in file with .sig suffix

                                                                                                                                                                                                                                                                • VerifyFile - Verify a file using a signature file. The key which has been used for signing must be imported in the keyring.

                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                  85.3. Global Functions

                                                                                                                                                                                                                                                                  85.3.1. CreateKey

                                                                                                                                                                                                                                                                  Create a new gpg key. Executes 'gpg --gen-key' in an xterm window (in the QT UI) or in the terminal window (in the ncurses UI).

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                  85.3.2. ExportAsciiPublicKey

                                                                                                                                                                                                                                                                  Export a public gpg key in ACSII armored file.

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string keyid

                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • boolean - true if the file has been successfuly signed

                                                                                                                                                                                                                                                                  85.3.3. ExportPublicKey

                                                                                                                                                                                                                                                                  Export a public gpg key in binary format.

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string keyid

                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • boolean - true if the file has been successfuly signed

                                                                                                                                                                                                                                                                  85.3.4. Init

                                                                                                                                                                                                                                                                  (Re)initialize the module, the cache is invalidated if the home directory is changed.

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string home_dir

                                                                                                                                                                                                                                                                  • boolean force

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                  85.3.5. PrivateKeys

                                                                                                                                                                                                                                                                  Return list of the private keys in the keyring.

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • list<map> - public keys: [ $["fingerprint": string key_fingerprint, "id": string key_ID, "uid": list<string> user_ids], ...]

                                                                                                                                                                                                                                                                  85.3.6. PublicKeys

                                                                                                                                                                                                                                                                  Return list of the public keys in the keyring.

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • list<map> - public keys: [ $["fingerprint": string key_fingerprint, "id": string key_ID, "uid": list<string> user_ids], ...]

                                                                                                                                                                                                                                                                  85.3.7. SignAsciiDetached

                                                                                                                                                                                                                                                                  Sign a file. The ASCII armored signature is stored in file with .asc suffix

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string keyid

                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                  • string passphrase

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • boolean - true if the file has been successfuly signed

                                                                                                                                                                                                                                                                  85.3.8. SignDetached

                                                                                                                                                                                                                                                                  Sign a file. The binary signature is stored in file with .sig suffix

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string keyid

                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                  • string passphrase

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • boolean - true if the file has been successfuly signed

                                                                                                                                                                                                                                                                  85.3.9. VerifyFile

                                                                                                                                                                                                                                                                  Verify a file using a signature file. The key which has been used for signing must be imported in the keyring.

                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                  • string sig_file

                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                  • boolean - true if the file has been successfuly verified

                                                                                                                                                                                                                                                                  85.4. Global Variables

                                                                                                                                                                                                                                                                  85.5. Module Requirements

                                                                                                                                                                                                                                                                  85.5.1. Module Imports

                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                  • String

                                                                                                                                                                                                                                                                  85.5.2. Module Includes

                                                                                                                                                                                                                                                                    86. GPGWidgets

                                                                                                                                                                                                                                                                    UI widgets and functions related to GPG

                                                                                                                                                                                                                                                                    86.1. Authors

                                                                                                                                                                                                                                                                    • Ladislav SlezĂĄk <lslezak@suse.cz>

                                                                                                                                                                                                                                                                    86.2. Summary of Module Globals

                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                      86.3. Global Functions

                                                                                                                                                                                                                                                                      86.3.1. AskPassphrasePopup

                                                                                                                                                                                                                                                                      Ask user to enter the passphrase for the selected gpg key. A a popup window is displayed.

                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                      • string key

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • string - the entered passphrase or nil if the popup has been closed by [Cancel] button

                                                                                                                                                                                                                                                                      86.3.2. AskPassphraseWidget

                                                                                                                                                                                                                                                                      Return definition of the passphrase CWM widget.

                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                      • string key

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • map<string, map<string,any> > - widget definition

                                                                                                                                                                                                                                                                      86.3.3. Passphrase

                                                                                                                                                                                                                                                                      Get the enterd passphrase.

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • string - passphrase

                                                                                                                                                                                                                                                                      86.3.4. SelectedPrivateKey

                                                                                                                                                                                                                                                                      Return the selected private key in the private table widget

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • string - key ID

                                                                                                                                                                                                                                                                      86.3.5. SetSelectedPrivateKey

                                                                                                                                                                                                                                                                      Set selected private key in the private key table widget.

                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                      • string keyid

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                      86.3.6. SetSelectedPublicKey

                                                                                                                                                                                                                                                                      Set selected public key in the public key table widget.

                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                      • string keyid

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                      86.3.7. Widgets

                                                                                                                                                                                                                                                                      Return a map with CWM widgets definition. The map contains definitions of all static CWM widgets.

                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                      • map<string,map<string,any> > - CWM widgets

                                                                                                                                                                                                                                                                      86.4. Global Variables

                                                                                                                                                                                                                                                                      86.5. Module Requirements

                                                                                                                                                                                                                                                                      86.5.1. Module Imports

                                                                                                                                                                                                                                                                      • CWM
                                                                                                                                                                                                                                                                      • CommandLine
                                                                                                                                                                                                                                                                      • GPG
                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                      • Mode

                                                                                                                                                                                                                                                                      86.5.2. Module Includes

                                                                                                                                                                                                                                                                        87. GetInstArgs

                                                                                                                                                                                                                                                                        Get client arguments

                                                                                                                                                                                                                                                                        87.1. Authors

                                                                                                                                                                                                                                                                        • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                        87.2. Summary of Module Globals

                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                        • Buttons - Returns map of client parameters only with keys: "enable_back" and "enable_next"

                                                                                                                                                                                                                                                                        • ButtonsProposal - Returns map of client parameters only with keys: "enable_back", "enable_next", and "proposal"

                                                                                                                                                                                                                                                                        • argmap - Returns map of client parameters

                                                                                                                                                                                                                                                                        • automatic_configuration - Is the automatic configuraton just in progress?

                                                                                                                                                                                                                                                                        • enable_back - Should be the [Back] button enabled?

                                                                                                                                                                                                                                                                        • enable_next - Should be the [Next] button enabled?

                                                                                                                                                                                                                                                                        • going_back - Are we going back from the previous dialog?

                                                                                                                                                                                                                                                                        • proposal - Returns name of the proposal

                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                          87.3. Global Functions

                                                                                                                                                                                                                                                                          87.3.1. Buttons

                                                                                                                                                                                                                                                                          Returns map of client parameters only with keys: "enable_back" and "enable_next"

                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                          • boolean back

                                                                                                                                                                                                                                                                          • boolean next

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • map - of parameters

                                                                                                                                                                                                                                                                          Example 13. 

                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                          	GetInstArgs::Buttons() -> $[
                                                                                                                                                                                                                                                                          		"enable_back" : false,
                                                                                                                                                                                                                                                                          		"enable_next" : true
                                                                                                                                                                                                                                                                          	]


                                                                                                                                                                                                                                                                          87.3.2. ButtonsProposal

                                                                                                                                                                                                                                                                          Returns map of client parameters only with keys: "enable_back", "enable_next", and "proposal"

                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                          • boolean back

                                                                                                                                                                                                                                                                          • boolean next

                                                                                                                                                                                                                                                                          • string proposal_name

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • map - of parameters

                                                                                                                                                                                                                                                                          Example 14. 

                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                          	GetInstArgs::ButtonsProposal() -> $[
                                                                                                                                                                                                                                                                          		"enable_back" : true,
                                                                                                                                                                                                                                                                          		"enable_next" : true,
                                                                                                                                                                                                                                                                          		"proposal"  : "initial"
                                                                                                                                                                                                                                                                          	]


                                                                                                                                                                                                                                                                          87.3.3. argmap

                                                                                                                                                                                                                                                                          Returns map of client parameters

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • map - of parameters

                                                                                                                                                                                                                                                                          Example 15. 

                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                          	GetInstArgs::argmap() -> $[
                                                                                                                                                                                                                                                                          		"enable_back" : true,
                                                                                                                                                                                                                                                                          		"enable_next" : true,
                                                                                                                                                                                                                                                                          		"going_back"  : true,
                                                                                                                                                                                                                                                                          		"anything"    : "yes, of course",
                                                                                                                                                                                                                                                                          	]


                                                                                                                                                                                                                                                                          87.3.4. automatic_configuration

                                                                                                                                                                                                                                                                          Is the automatic configuraton just in progress?

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • boolean - if running the automatic configuration

                                                                                                                                                                                                                                                                          87.3.5. enable_back

                                                                                                                                                                                                                                                                          Should be the [Back] button enabled?

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • boolean - whether enabled or not

                                                                                                                                                                                                                                                                          87.3.6. enable_next

                                                                                                                                                                                                                                                                          Should be the [Next] button enabled?

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • boolean - whether enabled or not

                                                                                                                                                                                                                                                                          87.3.7. going_back

                                                                                                                                                                                                                                                                          Are we going back from the previous dialog?

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • boolean - whether going_back or not

                                                                                                                                                                                                                                                                          87.3.8. proposal

                                                                                                                                                                                                                                                                          Returns name of the proposal

                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                          • string - proposal name

                                                                                                                                                                                                                                                                          Example 16. 

                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                          	GetInstArgs::proposal() -> "initial"
                                                                                                                                                                                                                                                                          	GetInstArgs::proposal() -> "network"
                                                                                                                                                                                                                                                                          	GetInstArgs::proposal() -> "hardware"


                                                                                                                                                                                                                                                                          87.4. Global Variables

                                                                                                                                                                                                                                                                          87.5. Module Requirements

                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                          88. GfxMenu

                                                                                                                                                                                                                                                                          Routines to maintain translations in the graphical bootloader menu

                                                                                                                                                                                                                                                                          88.1. Authors

                                                                                                                                                                                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                          • Olaf Dabrunz <od@suse.de>

                                                                                                                                                                                                                                                                          88.2. Summary of Module Globals

                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                          • ReplaceRegexMatch - Replace every match of given regular expression in a string with a replacement string

                                                                                                                                                                                                                                                                          • Update - Updates GFX menu without requiring any information, reads loader type from sysconfig, calls /sbin/lilo if LILO is being used directly

                                                                                                                                                                                                                                                                          • UpdateGfxMenuContents - Update graphical bootloader to contain translations for section labels in the currently selected installation language (set in /etc/sysconfig/language, RC_LANG) And make the selected installation language default

                                                                                                                                                                                                                                                                          • getTranslationsToDiacritics - Get translated section names, including diacritics

                                                                                                                                                                                                                                                                          • translateSectionTitle - Create translated name of a section

                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                            88.3. Global Functions

                                                                                                                                                                                                                                                                            88.3.1. ReplaceRegexMatch

                                                                                                                                                                                                                                                                            Replace every match of given regular expression in a string with a replacement string

                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                            • string regex

                                                                                                                                                                                                                                                                            • string repl

                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                            • string - that has matches replaced

                                                                                                                                                                                                                                                                            88.3.2. Update

                                                                                                                                                                                                                                                                            Updates GFX menu without requiring any information, reads loader type from sysconfig, calls /sbin/lilo if LILO is being used directly

                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                            88.3.3. UpdateGfxMenuContents

                                                                                                                                                                                                                                                                            Update graphical bootloader to contain translations for section labels in the currently selected installation language (set in /etc/sysconfig/language, RC_LANG) And make the selected installation language default

                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                            • string loader

                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                            88.3.4. getTranslationsToDiacritics

                                                                                                                                                                                                                                                                            Get translated section names, including diacritics

                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                            • string loader

                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                            • map<string,string> - a map section names translations

                                                                                                                                                                                                                                                                            88.3.5. translateSectionTitle

                                                                                                                                                                                                                                                                            Create translated name of a section

                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                            • string orig

                                                                                                                                                                                                                                                                            • string loader

                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                            • string - translated section name

                                                                                                                                                                                                                                                                            88.4. Global Variables

                                                                                                                                                                                                                                                                            88.5. Module Requirements

                                                                                                                                                                                                                                                                            88.5.1. Module Imports

                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                            • Product
                                                                                                                                                                                                                                                                            • Product
                                                                                                                                                                                                                                                                            • Product

                                                                                                                                                                                                                                                                            88.5.2. Module Includes

                                                                                                                                                                                                                                                                              89. Greasemonkey

                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                              89.1. Authors

                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                              • Lets see if this turns out to be useful.

                                                                                                                                                                                                                                                                              89.2. Summary of Module Globals

                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                  89.3. Global Functions

                                                                                                                                                                                                                                                                                  89.4. Global Variables

                                                                                                                                                                                                                                                                                  89.5. Module Requirements

                                                                                                                                                                                                                                                                                  89.5.1. Module Imports

                                                                                                                                                                                                                                                                                  • Directory

                                                                                                                                                                                                                                                                                  89.5.2. Module Includes

                                                                                                                                                                                                                                                                                    90. HTML

                                                                                                                                                                                                                                                                                    Generic HTML formatting

                                                                                                                                                                                                                                                                                    90.1. Authors

                                                                                                                                                                                                                                                                                    • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                    90.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                    • Bold - Make a piece of HTML code bold

                                                                                                                                                                                                                                                                                    • ColoredList - Make a HTML (unsorted) colored list from a list of strings

                                                                                                                                                                                                                                                                                    • Colorize - Colorize a piece of HTML code

                                                                                                                                                                                                                                                                                    • Heading - Make a HTML heading from a text

                                                                                                                                                                                                                                                                                    • Link - Make a HTML link

                                                                                                                                                                                                                                                                                    • List - Make a HTML (unsorted) list from a list of strings

                                                                                                                                                                                                                                                                                    • ListEnd - End a HTML (unsorted) list

                                                                                                                                                                                                                                                                                    • ListItem - Make a HTML list item

                                                                                                                                                                                                                                                                                    • ListStart - Start a HTML (unsorted) list

                                                                                                                                                                                                                                                                                    • Newline - Make a forced HTML line break

                                                                                                                                                                                                                                                                                    • Newlines - Make a number of forced HTML line breaks

                                                                                                                                                                                                                                                                                    • Para - Make a HTML paragraph from a text

                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                      90.3. Global Functions

                                                                                                                                                                                                                                                                                      90.3.1. Bold

                                                                                                                                                                                                                                                                                      Make a piece of HTML code bold

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.2. ColoredList

                                                                                                                                                                                                                                                                                      Make a HTML (unsorted) colored list from a list of strings

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • list<string> items

                                                                                                                                                                                                                                                                                      • string color

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.3. Colorize

                                                                                                                                                                                                                                                                                      Colorize a piece of HTML code

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      • string color

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.4. Heading

                                                                                                                                                                                                                                                                                      Make a HTML heading from a text

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.5. Link

                                                                                                                                                                                                                                                                                      Make a HTML link

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      • string link_id

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.6. List

                                                                                                                                                                                                                                                                                      Make a HTML (unsorted) list from a list of strings

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • list<string> items

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.7. ListEnd

                                                                                                                                                                                                                                                                                      End a HTML (unsorted) list

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.8. ListItem

                                                                                                                                                                                                                                                                                      Make a HTML list item

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.9. ListStart

                                                                                                                                                                                                                                                                                      Start a HTML (unsorted) list

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.10. Newline

                                                                                                                                                                                                                                                                                      Make a forced HTML line break

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.11. Newlines

                                                                                                                                                                                                                                                                                      Make a number of forced HTML line breaks

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • integer count

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.3.12. Para

                                                                                                                                                                                                                                                                                      Make a HTML paragraph from a text

                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                      • string - HTML code

                                                                                                                                                                                                                                                                                      90.4. Global Variables

                                                                                                                                                                                                                                                                                      90.5. Module Requirements

                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                      91. HTTP

                                                                                                                                                                                                                                                                                      Handle HTTP Requests

                                                                                                                                                                                                                                                                                      91.1. Authors

                                                                                                                                                                                                                                                                                      • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                      91.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                      • Get - Send a get request

                                                                                                                                                                                                                                                                                      • Post - Send a post request

                                                                                                                                                                                                                                                                                      • setUserPassword - Set user and password for HTTP authentication

                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                        91.3. Global Functions

                                                                                                                                                                                                                                                                                        91.3.1. Get

                                                                                                                                                                                                                                                                                        Send a get request

                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                        • string url

                                                                                                                                                                                                                                                                                        • string output

                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                        • map - Reponse map with HTTP code and transfer size and time

                                                                                                                                                                                                                                                                                        91.3.2. Post

                                                                                                                                                                                                                                                                                        Send a post request

                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                        • string url

                                                                                                                                                                                                                                                                                        • string output

                                                                                                                                                                                                                                                                                        • string postData

                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                        • map - Reponse map with HTTP code and transfer size and time

                                                                                                                                                                                                                                                                                        91.3.3. setUserPassword

                                                                                                                                                                                                                                                                                        Set user and password for HTTP authentication

                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                        • map

                                                                                                                                                                                                                                                                                        91.4. Global Variables

                                                                                                                                                                                                                                                                                        91.5. Module Requirements

                                                                                                                                                                                                                                                                                        none

                                                                                                                                                                                                                                                                                        92. HWConfig

                                                                                                                                                                                                                                                                                        Module for accessing hardware configuration files (/etc/sysconfig/hwcfg-*)

                                                                                                                                                                                                                                                                                        92.1. Authors

                                                                                                                                                                                                                                                                                        • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                        92.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                        • ConfigFiles - Return list of all available hardware configuration files

                                                                                                                                                                                                                                                                                        • Flush - Flush - write the changes to files

                                                                                                                                                                                                                                                                                        • GetComment - Get comment of the variable from the config file

                                                                                                                                                                                                                                                                                        • GetValue - Set comment of the variable in the config file

                                                                                                                                                                                                                                                                                        • RemoveConfig - Remove configuration file from system

                                                                                                                                                                                                                                                                                        • SetComment - Set comment of the variable in the config file

                                                                                                                                                                                                                                                                                        • SetValue - Set value of the variable in the config file

                                                                                                                                                                                                                                                                                        • Values - Read all values from the file

                                                                                                                                                                                                                                                                                        • Variables - Return list of all available variable in the configuration file

                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                          92.3. Global Functions

                                                                                                                                                                                                                                                                                          92.3.1. ConfigFiles

                                                                                                                                                                                                                                                                                          Return list of all available hardware configuration files

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • list<string> - found files

                                                                                                                                                                                                                                                                                          92.3.2. Flush

                                                                                                                                                                                                                                                                                          Flush - write the changes to files

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          92.3.3. GetComment

                                                                                                                                                                                                                                                                                          Get comment of the variable from the config file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          • string variable

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • string - comment of the variable

                                                                                                                                                                                                                                                                                          92.3.4. GetValue

                                                                                                                                                                                                                                                                                          Set comment of the variable in the config file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          • string variable

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • string - comment the new comment

                                                                                                                                                                                                                                                                                          92.3.5. RemoveConfig

                                                                                                                                                                                                                                                                                          Remove configuration file from system

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          92.3.6. SetComment

                                                                                                                                                                                                                                                                                          Set comment of the variable in the config file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          • string variable

                                                                                                                                                                                                                                                                                          • string comment

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          92.3.7. SetValue

                                                                                                                                                                                                                                                                                          Set value of the variable in the config file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          • string variable

                                                                                                                                                                                                                                                                                          • string value

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          92.3.8. Values

                                                                                                                                                                                                                                                                                          Read all values from the file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • map<string,string> - map $[ "VARIABLE" : "value" ]

                                                                                                                                                                                                                                                                                          92.3.9. Variables

                                                                                                                                                                                                                                                                                          Return list of all available variable in the configuration file

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • list<string> - found variables

                                                                                                                                                                                                                                                                                          92.4. Global Variables

                                                                                                                                                                                                                                                                                          92.5. Module Requirements

                                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                                          93. Heartbeat

                                                                                                                                                                                                                                                                                          Heartbeat settings, input and output functions

                                                                                                                                                                                                                                                                                          93.1. Authors

                                                                                                                                                                                                                                                                                          • Martin Lazar <mlazar@suse.cz>

                                                                                                                                                                                                                                                                                          93.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                          • Abort - Abort function

                                                                                                                                                                                                                                                                                          • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                          • Export - Dump the heartbeat settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                          • Import - Get all heartbeat settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                          • Modified - Prototypes

                                                                                                                                                                                                                                                                                          • Modified - Data was modified?

                                                                                                                                                                                                                                                                                          • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                          • Read - Read all heartbeat settings

                                                                                                                                                                                                                                                                                          • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                          • Write - Write all heartbeat settings

                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                          • proposal_valid -

                                                                                                                                                                                                                                                                                          • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                          93.3. Global Functions

                                                                                                                                                                                                                                                                                          93.3.1. Abort

                                                                                                                                                                                                                                                                                          Abort function

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - return true if abort

                                                                                                                                                                                                                                                                                          93.3.2. AutoPackages

                                                                                                                                                                                                                                                                                          Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • map - with 2 lists.

                                                                                                                                                                                                                                                                                          93.3.3. Export

                                                                                                                                                                                                                                                                                          Dump the heartbeat settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                          93.3.4. Import

                                                                                                                                                                                                                                                                                          Get all heartbeat settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - True on success

                                                                                                                                                                                                                                                                                          93.3.5. Modified

                                                                                                                                                                                                                                                                                          Prototypes

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                          93.3.6. Modified

                                                                                                                                                                                                                                                                                          Data was modified?

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true if modified

                                                                                                                                                                                                                                                                                          93.3.7. Overview

                                                                                                                                                                                                                                                                                          Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • list - table items

                                                                                                                                                                                                                                                                                          93.3.8. Read

                                                                                                                                                                                                                                                                                          Read all heartbeat settings

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          93.3.9. Summary

                                                                                                                                                                                                                                                                                          Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • list - summary of the current configuration

                                                                                                                                                                                                                                                                                          93.3.10. Write

                                                                                                                                                                                                                                                                                          Write all heartbeat settings

                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                          93.4. Global Variables

                                                                                                                                                                                                                                                                                          93.4.1. proposal_valid

                                                                                                                                                                                                                                                                                          93.4.2. write_only

                                                                                                                                                                                                                                                                                          Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                          93.5. Module Requirements

                                                                                                                                                                                                                                                                                          93.5.1. Module Imports

                                                                                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                                                                                          • PackageSystem
                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                          93.5.2. Module Includes

                                                                                                                                                                                                                                                                                            94. Hooks

                                                                                                                                                                                                                                                                                            Provide debug hooks during installation

                                                                                                                                                                                                                                                                                            94.1. Authors

                                                                                                                                                                                                                                                                                            • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                            94.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                            • Checkpoint - called whenever an inst_*.ycp file is called during installation. checks if /tmp/<filename> exists and pops up a "Entry: <filename>" or "Exit: <filename>" box

                                                                                                                                                                                                                                                                                            • Run - Run Script

                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                              94.3. Global Functions

                                                                                                                                                                                                                                                                                              94.3.1. Checkpoint

                                                                                                                                                                                                                                                                                              called whenever an inst_*.ycp file is called during installation. checks if /tmp/<filename> exists and pops up a "Entry: <filename>" or "Exit: <filename>" box

                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                              • string filename

                                                                                                                                                                                                                                                                                              • boolean at_entry

                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                              94.3.2. Run

                                                                                                                                                                                                                                                                                              Run Script

                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                              • string filename

                                                                                                                                                                                                                                                                                              • boolean at_entry

                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                              94.4. Global Variables

                                                                                                                                                                                                                                                                                              94.5. Module Requirements

                                                                                                                                                                                                                                                                                              94.5.1. Module Imports

                                                                                                                                                                                                                                                                                              • Directory
                                                                                                                                                                                                                                                                                              • Popup

                                                                                                                                                                                                                                                                                              94.5.2. Module Includes

                                                                                                                                                                                                                                                                                                95. Host

                                                                                                                                                                                                                                                                                                Hosts data (/etc/hosts)

                                                                                                                                                                                                                                                                                                95.1. Authors

                                                                                                                                                                                                                                                                                                • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                95.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                • Export - Dump the Hosts settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                • GetModified - Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                • GetSystemHosts - Return "system" predefined hosts (should be present all the time)

                                                                                                                                                                                                                                                                                                • Import - Get all the Hosts configuration from a map. When called by hosts_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                • Read - Read hosts settings

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

                                                                                                                                                                                                                                                                                                • Summary - Create summary

                                                                                                                                                                                                                                                                                                • Update - Update hosts according to the current hostname (only one hostname, assigned to all IPs)

                                                                                                                                                                                                                                                                                                • Write - Write hosts settings and apply changes

                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                • hosts - All hosts See hosts(5) keys: IPs, (But #35671 suggests that repeating IPs is valid) values: names, the first one is the canonical one

                                                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                                                • write_only - Only write configuration

                                                                                                                                                                                                                                                                                                95.3. Global Functions

                                                                                                                                                                                                                                                                                                95.3.1. Export

                                                                                                                                                                                                                                                                                                Dump the Hosts settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • map - autoinstallation settings

                                                                                                                                                                                                                                                                                                95.3.2. GetModified

                                                                                                                                                                                                                                                                                                Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - settings were modified

                                                                                                                                                                                                                                                                                                95.3.3. GetSystemHosts

                                                                                                                                                                                                                                                                                                Return "system" predefined hosts (should be present all the time)

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • list - of system hosts

                                                                                                                                                                                                                                                                                                95.3.4. Import

                                                                                                                                                                                                                                                                                                Get all the Hosts configuration from a map. When called by hosts_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if success

                                                                                                                                                                                                                                                                                                95.3.5. Read

                                                                                                                                                                                                                                                                                                Read hosts settings

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if success

                                                                                                                                                                                                                                                                                                95.3.6. SetModified

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

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                95.3.7. Summary

                                                                                                                                                                                                                                                                                                Create summary

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - summary text

                                                                                                                                                                                                                                                                                                95.3.8. Update

                                                                                                                                                                                                                                                                                                Update hosts according to the current hostname (only one hostname, assigned to all IPs)

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string oldhn

                                                                                                                                                                                                                                                                                                • string newhn

                                                                                                                                                                                                                                                                                                • list<string> iplist

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if success

                                                                                                                                                                                                                                                                                                95.3.9. Write

                                                                                                                                                                                                                                                                                                Write hosts settings and apply changes

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if success

                                                                                                                                                                                                                                                                                                95.4. Global Variables

                                                                                                                                                                                                                                                                                                95.4.1. hosts

                                                                                                                                                                                                                                                                                                All hosts See hosts(5) keys: IPs, (But #35671 suggests that repeating IPs is valid) values: names, the first one is the canonical one

                                                                                                                                                                                                                                                                                                95.4.2. modified

                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                95.4.3. write_only

                                                                                                                                                                                                                                                                                                Only write configuration

                                                                                                                                                                                                                                                                                                95.5. Module Requirements

                                                                                                                                                                                                                                                                                                95.5.1. Module Imports

                                                                                                                                                                                                                                                                                                • Hostname
                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                                                                                                95.5.2. Module Includes

                                                                                                                                                                                                                                                                                                • network/routines.ycp

                                                                                                                                                                                                                                                                                                96. Hostname

                                                                                                                                                                                                                                                                                                Hostname manipulation routines

                                                                                                                                                                                                                                                                                                96.1. Authors

                                                                                                                                                                                                                                                                                                • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                96.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                • Check - Check syntax of hostname entry (that is a domain name component, unqualified, without dots)

                                                                                                                                                                                                                                                                                                • CheckDomain - Check syntax of domain entry

                                                                                                                                                                                                                                                                                                • CheckFQ - Check syntax of fully qualified hostname

                                                                                                                                                                                                                                                                                                • CurrentDomain - Retrieve currently set domain name

                                                                                                                                                                                                                                                                                                • CurrentFQ - Retrieve currently set fully qualified hostname (uses hostname --fqdn)

                                                                                                                                                                                                                                                                                                • CurrentHostname - Retrieve currently set (short) hostname

                                                                                                                                                                                                                                                                                                • MergeFQ - Merge short hostname and domain to full-qualified host name

                                                                                                                                                                                                                                                                                                • SplitFQ - Split FQ hostname to hostname and domain name

                                                                                                                                                                                                                                                                                                • ValidDomain - describe a valid domain name

                                                                                                                                                                                                                                                                                                • ValidFQ - describe a valid FQ host name

                                                                                                                                                                                                                                                                                                • ValidHost - describe a valid host name

                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                • ValidChars - i18n characters in domain names are still not allowed

                                                                                                                                                                                                                                                                                                96.3. Global Functions

                                                                                                                                                                                                                                                                                                96.3.1. Check

                                                                                                                                                                                                                                                                                                Check syntax of hostname entry (that is a domain name component, unqualified, without dots)

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string host

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                • rfc1123, rfc2396 and obsoleted rfc1034

                                                                                                                                                                                                                                                                                                96.3.2. CheckDomain

                                                                                                                                                                                                                                                                                                Check syntax of domain entry

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string domain

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                96.3.3. CheckFQ

                                                                                                                                                                                                                                                                                                Check syntax of fully qualified hostname

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string host

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                96.3.4. CurrentDomain

                                                                                                                                                                                                                                                                                                Retrieve currently set domain name

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - domain

                                                                                                                                                                                                                                                                                                96.3.5. CurrentFQ

                                                                                                                                                                                                                                                                                                Retrieve currently set fully qualified hostname (uses hostname --fqdn)

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - FQ hostname

                                                                                                                                                                                                                                                                                                96.3.6. CurrentHostname

                                                                                                                                                                                                                                                                                                Retrieve currently set (short) hostname

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - hostname

                                                                                                                                                                                                                                                                                                96.3.7. MergeFQ

                                                                                                                                                                                                                                                                                                Merge short hostname and domain to full-qualified host name

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string hostname

                                                                                                                                                                                                                                                                                                • string domain

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - FQ hostname

                                                                                                                                                                                                                                                                                                96.3.8. SplitFQ

                                                                                                                                                                                                                                                                                                Split FQ hostname to hostname and domain name

                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                • string fqhostname

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • list<string> - of hostname and domain name

                                                                                                                                                                                                                                                                                                Example 17. 

                                                                                                                                                                                                                                                                                                 Hostname::SplitFQ("ftp.suse.cz") -> ["ftp", "suse.cz"]
                                                                                                                                                                                                                                                                                                 Hostname::SplitFQ("ftp") -> ["ftp"]


                                                                                                                                                                                                                                                                                                96.3.9. ValidDomain

                                                                                                                                                                                                                                                                                                describe a valid domain name

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - description

                                                                                                                                                                                                                                                                                                96.3.10. ValidFQ

                                                                                                                                                                                                                                                                                                describe a valid FQ host name

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - describe a valid FQ host name

                                                                                                                                                                                                                                                                                                96.3.11. ValidHost

                                                                                                                                                                                                                                                                                                describe a valid host name

                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                • string - description

                                                                                                                                                                                                                                                                                                96.4. Global Variables

                                                                                                                                                                                                                                                                                                96.4.1. ValidChars

                                                                                                                                                                                                                                                                                                i18n characters in domain names are still not allowed

                                                                                                                                                                                                                                                                                                96.5. Module Requirements

                                                                                                                                                                                                                                                                                                96.5.1. Module Imports

                                                                                                                                                                                                                                                                                                • IP
                                                                                                                                                                                                                                                                                                • String

                                                                                                                                                                                                                                                                                                96.5.2. Module Includes

                                                                                                                                                                                                                                                                                                  97. Hotplug

                                                                                                                                                                                                                                                                                                  provide hotplug (USB, FireWire, PCMCIA) functions

                                                                                                                                                                                                                                                                                                  97.1. Authors

                                                                                                                                                                                                                                                                                                  • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                  • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                  97.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                  • haveFireWire - if a firewire controller was found and initialized

                                                                                                                                                                                                                                                                                                  • haveUSB - if a usb controller was found and initialized

                                                                                                                                                                                                                                                                                                  97.3. Global Functions

                                                                                                                                                                                                                                                                                                  97.3.1. StartFireWire

                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                  • void - probe for firewire type, load appropriate modules, and mount usbfs to /proc/bus/usb

                                                                                                                                                                                                                                                                                                  97.3.2. StartUSB

                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                  • void - probe for usb type, load appropriate modules, and mount usbfs to /proc/bus/usb

                                                                                                                                                                                                                                                                                                  97.4. Global Variables

                                                                                                                                                                                                                                                                                                  97.4.1. haveFireWire

                                                                                                                                                                                                                                                                                                  if a firewire controller was found and initialized

                                                                                                                                                                                                                                                                                                  97.4.2. haveUSB

                                                                                                                                                                                                                                                                                                  if a usb controller was found and initialized

                                                                                                                                                                                                                                                                                                  97.5. Module Requirements

                                                                                                                                                                                                                                                                                                  97.5.1. Module Imports

                                                                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                                                                  • HwStatus
                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                  • ModuleLoading

                                                                                                                                                                                                                                                                                                  97.5.2. Module Includes

                                                                                                                                                                                                                                                                                                    98. HttpServer

                                                                                                                                                                                                                                                                                                    Data for configuration of http-server, input and output functions.

                                                                                                                                                                                                                                                                                                    98.1. Authors

                                                                                                                                                                                                                                                                                                    • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                    98.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                    • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                    • Export - Dump the http-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                    • Import - Get all http-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                    • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                    • Read - Read all http-server settings

                                                                                                                                                                                                                                                                                                    • Summary - Create a textual summary for the current configuration

                                                                                                                                                                                                                                                                                                    • Write - Write all http-server settings

                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                    • ip2device - Mapping of IPs to network devices

                                                                                                                                                                                                                                                                                                    • modified - Data was modified?

                                                                                                                                                                                                                                                                                                    • required_packages - Required packages

                                                                                                                                                                                                                                                                                                    • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                    98.3. Global Functions

                                                                                                                                                                                                                                                                                                    98.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                    Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                    98.3.2. Export

                                                                                                                                                                                                                                                                                                    Dump the http-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                    98.3.3. Import

                                                                                                                                                                                                                                                                                                    Get all http-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                    • map s

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                    98.3.4. Modified

                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • boolean - true if modified

                                                                                                                                                                                                                                                                                                    98.3.5. Read

                                                                                                                                                                                                                                                                                                    Read all http-server settings

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                    98.3.6. Summary

                                                                                                                                                                                                                                                                                                    Create a textual summary for the current configuration

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                    98.3.7. Write

                                                                                                                                                                                                                                                                                                    Write all http-server settings

                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                    98.4. Global Variables

                                                                                                                                                                                                                                                                                                    98.4.1. ip2device

                                                                                                                                                                                                                                                                                                    Mapping of IPs to network devices

                                                                                                                                                                                                                                                                                                    98.4.2. modified

                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                    98.4.3. required_packages

                                                                                                                                                                                                                                                                                                    Required packages

                                                                                                                                                                                                                                                                                                    98.4.4. write_only

                                                                                                                                                                                                                                                                                                    Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                    98.5. Module Requirements

                                                                                                                                                                                                                                                                                                    98.5.1. Module Imports

                                                                                                                                                                                                                                                                                                    • Confirm
                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                    • DnsServerAPI
                                                                                                                                                                                                                                                                                                    • FileChanges
                                                                                                                                                                                                                                                                                                    • Message
                                                                                                                                                                                                                                                                                                    • NetworkInterfaces
                                                                                                                                                                                                                                                                                                    • NetworkService
                                                                                                                                                                                                                                                                                                    • Package
                                                                                                                                                                                                                                                                                                    • Package
                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                    • Service
                                                                                                                                                                                                                                                                                                    • SuSEFirewall
                                                                                                                                                                                                                                                                                                    • SuSEFirewall
                                                                                                                                                                                                                                                                                                    • SuSEFirewallServices
                                                                                                                                                                                                                                                                                                    • Summary
                                                                                                                                                                                                                                                                                                    • YaPI::HTTPD
                                                                                                                                                                                                                                                                                                    • YaST::HTTPDData

                                                                                                                                                                                                                                                                                                    98.5.2. Module Includes

                                                                                                                                                                                                                                                                                                    • http-server/routines.ycp

                                                                                                                                                                                                                                                                                                    99. HwStatus

                                                                                                                                                                                                                                                                                                    All hardware status relevant functions are here

                                                                                                                                                                                                                                                                                                    99.1. Authors

                                                                                                                                                                                                                                                                                                    • Klaus Kaempf (kkaempf@suse.de)

                                                                                                                                                                                                                                                                                                    99.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                    • Get - Get() get status for device

                                                                                                                                                                                                                                                                                                    • Save - Save() save stati for all devices

                                                                                                                                                                                                                                                                                                    • Set - Set set status for a hardware device

                                                                                                                                                                                                                                                                                                    • Update - Update() set stati for all devices

                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                      99.3. Global Functions

                                                                                                                                                                                                                                                                                                      99.3.1. Get

                                                                                                                                                                                                                                                                                                      Get() get status for device

                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                      • string id

                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                      • symbol - status of device, (`yes or `no) returns `unknown if status wasn't set before

                                                                                                                                                                                                                                                                                                      99.3.2. Save

                                                                                                                                                                                                                                                                                                      Save() save stati for all devices

                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                      99.3.3. Set

                                                                                                                                                                                                                                                                                                      Set set status for a hardware device

                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                      • string id

                                                                                                                                                                                                                                                                                                      • symbol stat

                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                      99.3.4. Update

                                                                                                                                                                                                                                                                                                      Update() set stati for all devices

                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                      99.4. Global Variables

                                                                                                                                                                                                                                                                                                      99.5. Module Requirements

                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                      100. IP

                                                                                                                                                                                                                                                                                                      IP manipulation routines

                                                                                                                                                                                                                                                                                                      100.1. Authors

                                                                                                                                                                                                                                                                                                      • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                      100.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                      • BitsToIPv4 - Converts 32 bit binary number to its IPv4 repserentation.

                                                                                                                                                                                                                                                                                                      • Check - Check syntax of IP address

                                                                                                                                                                                                                                                                                                      • Check4 - Check syntax of IPv4 address

                                                                                                                                                                                                                                                                                                      • Check6 - Check syntax of IPv6 address

                                                                                                                                                                                                                                                                                                      • ComputeBroadcast - Compute IPv4 broadcast address from ip4 address and network mask.

                                                                                                                                                                                                                                                                                                      • ComputeNetwork - Compute IPv4 network address from ip4 address and network mask.

                                                                                                                                                                                                                                                                                                      • IPv4ToBits - Converts IPv4 into its 32 bit binary representation.

                                                                                                                                                                                                                                                                                                      • ToHex - Converts IPv4 address from string to hex format

                                                                                                                                                                                                                                                                                                      • ToInteger - Convert IPv4 address from string to integer

                                                                                                                                                                                                                                                                                                      • ToString - Convert IPv4 address from integer to string

                                                                                                                                                                                                                                                                                                      • Valid4 - Describe a valid IPv4 address

                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                        100.3. Global Functions

                                                                                                                                                                                                                                                                                                        100.3.1. BitsToIPv4

                                                                                                                                                                                                                                                                                                        Converts 32 bit binary number to its IPv4 repserentation.

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string bits

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - ipv4

                                                                                                                                                                                                                                                                                                        Example 18. 

                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                             BitsToIPv4("10111100000110001110001100000101") -> "188.24.227.5"
                                                                                                                                                                                                                                                                                                             BitsToIPv4("00110101000110001110001001100101") -> "53.24.226.101"


                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                        • IPv4ToBits()

                                                                                                                                                                                                                                                                                                        100.3.2. Check

                                                                                                                                                                                                                                                                                                        Check syntax of IP address

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if correct

                                                                                                                                                                                                                                                                                                        100.3.3. Check4

                                                                                                                                                                                                                                                                                                        Check syntax of IPv4 address

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if correct

                                                                                                                                                                                                                                                                                                        100.3.4. Check6

                                                                                                                                                                                                                                                                                                        Check syntax of IPv6 address

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if correct

                                                                                                                                                                                                                                                                                                        100.3.5. ComputeBroadcast

                                                                                                                                                                                                                                                                                                        Compute IPv4 broadcast address from ip4 address and network mask.

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        • string mask

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - computed broadcast

                                                                                                                                                                                                                                                                                                        100.3.6. ComputeNetwork

                                                                                                                                                                                                                                                                                                        Compute IPv4 network address from ip4 address and network mask.

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        • string mask

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - computed subnet

                                                                                                                                                                                                                                                                                                        100.3.7. IPv4ToBits

                                                                                                                                                                                                                                                                                                        Converts IPv4 into its 32 bit binary representation.

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ipv4

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - binary

                                                                                                                                                                                                                                                                                                        Example 19. 

                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                             IPv4ToBits("80.25.135.2")    -> "01010000000110011000011100000010"
                                                                                                                                                                                                                                                                                                             IPv4ToBits("172.24.233.211") -> "10101100000110001110100111010011"


                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                        • BitsToIPv4()

                                                                                                                                                                                                                                                                                                        100.3.8. ToHex

                                                                                                                                                                                                                                                                                                        Converts IPv4 address from string to hex format

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - representing IP in Hex

                                                                                                                                                                                                                                                                                                        Example 20. 

                                                                                                                                                                                                                                                                                                         IP::ToHex("192.168.1.1") -> "0xC0A80101"
                                                                                                                                                                                                                                                                                                         IP::ToHex("10.10.0.1") -> "0x0A0A0001"


                                                                                                                                                                                                                                                                                                        100.3.9. ToInteger

                                                                                                                                                                                                                                                                                                        Convert IPv4 address from string to integer

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • integer - ip address as integer

                                                                                                                                                                                                                                                                                                        100.3.10. ToString

                                                                                                                                                                                                                                                                                                        Convert IPv4 address from integer to string

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • integer ip

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - ip address as string

                                                                                                                                                                                                                                                                                                        100.3.11. Valid4

                                                                                                                                                                                                                                                                                                        Describe a valid IPv4 address

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • string - describtion a valid IPv4 address

                                                                                                                                                                                                                                                                                                        100.4. Global Variables

                                                                                                                                                                                                                                                                                                        100.5. Module Requirements

                                                                                                                                                                                                                                                                                                        none

                                                                                                                                                                                                                                                                                                        101. ISDN

                                                                                                                                                                                                                                                                                                        ISDN data

                                                                                                                                                                                                                                                                                                        101.1. Authors

                                                                                                                                                                                                                                                                                                        • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                        • Karsten Keil <kkeil@suse.de>

                                                                                                                                                                                                                                                                                                        101.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                        • CountIF - Count of valid interface entries

                                                                                                                                                                                                                                                                                                        • Export -

                                                                                                                                                                                                                                                                                                        • Import -

                                                                                                                                                                                                                                                                                                        • Locate - Locate interfaces of the given key and value

                                                                                                                                                                                                                                                                                                        • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                        • NetDeviceList - List of configured interface entries

                                                                                                                                                                                                                                                                                                        • OverviewDev -

                                                                                                                                                                                                                                                                                                        • PrepareInterface - If not allready done set a valid interface

                                                                                                                                                                                                                                                                                                        • Read - Read all ISDN settings from the SCR

                                                                                                                                                                                                                                                                                                        • SelectInterface - Displays a popup to select one interface to be the current interface

                                                                                                                                                                                                                                                                                                        • Summary - Build a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                        • TestDev - Test the given card settings

                                                                                                                                                                                                                                                                                                        • 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

                                                                                                                                                                                                                                                                                                        • ISDNCDB - ISDN database based on CDB

                                                                                                                                                                                                                                                                                                        • have_dsl - Flag for Fritz!card DSL configuration

                                                                                                                                                                                                                                                                                                        • hw_device - hold current device settings

                                                                                                                                                                                                                                                                                                        • interface - hold current interface settings

                                                                                                                                                                                                                                                                                                        • operation - Which operation is pending?

                                                                                                                                                                                                                                                                                                        • skip - If the interface or provider configuration is skipped

                                                                                                                                                                                                                                                                                                        101.3. Global Functions

                                                                                                                                                                                                                                                                                                        101.3.1. CountIF

                                                                                                                                                                                                                                                                                                        Count of valid interface entries

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • integer - count

                                                                                                                                                                                                                                                                                                        101.3.2. Export

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • map

                                                                                                                                                                                                                                                                                                        101.3.3. Import

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                        101.3.4. Locate

                                                                                                                                                                                                                                                                                                        Locate interfaces of the given key and value

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string key

                                                                                                                                                                                                                                                                                                        • string val

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • list<string> - of devices with key=val

                                                                                                                                                                                                                                                                                                        101.3.5. Modified

                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                        101.3.6. NetDeviceList

                                                                                                                                                                                                                                                                                                        List of configured interface entries

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • list<string> - <strings>

                                                                                                                                                                                                                                                                                                        101.3.7. OverviewDev

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • list

                                                                                                                                                                                                                                                                                                        101.3.8. PrepareInterface

                                                                                                                                                                                                                                                                                                        If not allready done set a valid interface

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if the selection was successful false if here aren't any interfaces

                                                                                                                                                                                                                                                                                                        101.3.9. Read

                                                                                                                                                                                                                                                                                                        Read all ISDN settings from the SCR

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                        101.3.10. SelectInterface

                                                                                                                                                                                                                                                                                                        Displays a popup to select one interface to be the current interface

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • boolean auto

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true if the selection war successful false if here aren't any interfaces

                                                                                                                                                                                                                                                                                                        101.3.11. Summary

                                                                                                                                                                                                                                                                                                        Build a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • boolean split

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                        101.3.12. TestDev

                                                                                                                                                                                                                                                                                                        Test the given card settings

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                        101.3.13. Write

                                                                                                                                                                                                                                                                                                        Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                        • boolean start

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true on success if start is true, load drivers and interfaces

                                                                                                                                                                                                                                                                                                        101.3.14. WriteOnly

                                                                                                                                                                                                                                                                                                        Only write configuration without starting any init scripts and SuSEconfig

                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                        101.4. Global Variables

                                                                                                                                                                                                                                                                                                        101.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                        Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                        101.4.2. ISDNCDB

                                                                                                                                                                                                                                                                                                        ISDN database based on CDB

                                                                                                                                                                                                                                                                                                        map with two keys, of maps: Cards: map, keyed by integers, of maps: CardID: integer (the key) VendorRef: integer bus: string (ISA) class: string (ISDN Single/Multiple Basic Rate) device: integer driver: list of driver maps features: integer lines: integer longname: string name: string revision: integer subdevice: integer subvendor: integer vendor: integer Vendors: map, keyed by integers, of maps: VendorID: integer (the key) name: string refcnt: integer shortname: string

                                                                                                                                                                                                                                                                                                        101.4.3. have_dsl

                                                                                                                                                                                                                                                                                                        Flag for Fritz!card DSL configuration

                                                                                                                                                                                                                                                                                                        101.4.4. hw_device

                                                                                                                                                                                                                                                                                                        hold current device settings

                                                                                                                                                                                                                                                                                                        handled items are line specific PROTOCOL D-channel protocol AREACODE international area code DIALPREFIX dialprefixfor PBX setups hw specific PARA_IO IO address for legacy ISA PARA_MEMBASE memory base address for legacy ISA PARA_IRQ IRQ number for legacy ISA PARA_TYPE card type PARA_SUBTYPE card sub type NAME full card name DRIVER driver module name STARTMODE "auto"|"manual"|"hotplug" DEBUG debuglevel UDI unique hw id

                                                                                                                                                                                                                                                                                                        101.4.5. interface

                                                                                                                                                                                                                                                                                                        hold current interface settings

                                                                                                                                                                                                                                                                                                        handled items are IPADDR local IP address REMOTE_ADDR remote IP address DEFAULTROUTE default route yes/no DYNAMICIP dynamic IP assignment yes/no PROTOCOL encapsulation "rawip" | "syncppp" MSN own phone number CHARGEHUP try to hangup on idle just before next charge CALLBACK callback mode CBDELAY callback delay STARTMODE auto | manual | hotplug USERCONTROL controllable bt user yes/no MULTILINK channel bundling yes/no PROVIDER default provider filename IPPPD_OPTIONS additional ipppd options

                                                                                                                                                                                                                                                                                                        101.4.6. operation

                                                                                                                                                                                                                                                                                                        Which operation is pending?

                                                                                                                                                                                                                                                                                                        101.4.7. skip

                                                                                                                                                                                                                                                                                                        If the interface or provider configuration is skipped

                                                                                                                                                                                                                                                                                                        101.5. Module Requirements

                                                                                                                                                                                                                                                                                                        101.5.1. Module Imports

                                                                                                                                                                                                                                                                                                        • NetworkInterfaces
                                                                                                                                                                                                                                                                                                        • NetworkService
                                                                                                                                                                                                                                                                                                        • PackageSystem
                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                        • Provider
                                                                                                                                                                                                                                                                                                        • SuSEFirewall4Network
                                                                                                                                                                                                                                                                                                        • Summary

                                                                                                                                                                                                                                                                                                        101.5.2. Module Includes

                                                                                                                                                                                                                                                                                                        • network/complex.ycp
                                                                                                                                                                                                                                                                                                        • network/devices.ycp
                                                                                                                                                                                                                                                                                                        • network/hardware.ycp
                                                                                                                                                                                                                                                                                                        • network/isdn/config.ycp
                                                                                                                                                                                                                                                                                                        • network/isdn/routines.ycp
                                                                                                                                                                                                                                                                                                        • network/routines.ycp
                                                                                                                                                                                                                                                                                                        • network/runtime.ycp

                                                                                                                                                                                                                                                                                                        102. ISSLEconfig

                                                                                                                                                                                                                                                                                                        Basic ISSLE setup

                                                                                                                                                                                                                                                                                                        102.1. Authors

                                                                                                                                                                                                                                                                                                        • Frank Balzer <frank.balzer@novell.com>

                                                                                                                                                                                                                                                                                                        102.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                            102.3. Global Functions

                                                                                                                                                                                                                                                                                                            102.4. Global Variables

                                                                                                                                                                                                                                                                                                            102.5. Module Requirements

                                                                                                                                                                                                                                                                                                            none

                                                                                                                                                                                                                                                                                                            103. Icon

                                                                                                                                                                                                                                                                                                            Transparent access to Icons

                                                                                                                                                                                                                                                                                                            103.1. Authors

                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <lukas.ocilka@suse.cz>

                                                                                                                                                                                                                                                                                                            103.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                            • Error - Returns UI term `Image() widget with an error-icon.

                                                                                                                                                                                                                                                                                                            • IconPath - Returns path to an image

                                                                                                                                                                                                                                                                                                            • Image - Returns `Image() term defined by parameters. Returns `Empty() if the current UI doesn't support images.

                                                                                                                                                                                                                                                                                                            • Info - Returns UI term `Image() widget with an info-icon.

                                                                                                                                                                                                                                                                                                            • Simple - Function calls Icon::Image with default options

                                                                                                                                                                                                                                                                                                            • Warning - Returns UI term `Image() widget with a warning-icon.

                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                              103.3. Global Functions

                                                                                                                                                                                                                                                                                                              103.3.1. Error

                                                                                                                                                                                                                                                                                                              Returns UI term `Image() widget with an error-icon.

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • term - error-icon

                                                                                                                                                                                                                                                                                                              103.3.2. IconPath

                                                                                                                                                                                                                                                                                                              Returns path to an image

                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                              • string icon_type

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • string

                                                                                                                                                                                                                                                                                                              Example 21. 

                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                              	Icon::IconPath ("warning") -> "/usr/share/YaST2/theme/current/icons/32x32/apps/msg_warning.png"


                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                              • Icon::Image() for details

                                                                                                                                                                                                                                                                                                              103.3.3. Image

                                                                                                                                                                                                                                                                                                              Returns `Image() term defined by parameters. Returns `Empty() if the current UI doesn't support images.

                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                              • string icon_type

                                                                                                                                                                                                                                                                                                              • map <string, any> options

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • term

                                                                                                                                                                                                                                                                                                              options = $[
                                                                                                                                                                                                                                                                                                                 "id" : any_icon_id,
                                                                                                                                                                                                                                                                                                                 "label" : (string) icon_label, // (used if icon is missing)
                                                                                                                                                                                                                                                                                                                 "margin_left" : 0,  // HSpacing on the left
                                                                                                                                                                                                                                                                                                                 "margin_right" : 5, // HSpacing on the right
                                                                                                                                                                                                                                                                                                               ]
                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                              Example 22. 

                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                Icon::Image ("warning", $["id":`my_warning, "label":_("My Warning")])
                                                                                                                                                                                                                                                                                                                  -> `Image (`id (`my_warning), "/usr/share/YaST2/theme/current/icons/32x32/apps/msg_warning.png", "My Warning")
                                                                                                                                                                                                                                                                                                                Icon::Image ("info", $["margin_left":1, "margin_right":2])
                                                                                                                                                                                                                                                                                                                  -> `HBox (
                                                                                                                                                                                                                                                                                                                    `HSpacing (1),
                                                                                                                                                                                                                                                                                                                    `Image (`id ("icon_id_info"), "/usr/share/YaST2/theme/current/icons/32x32/apps/msg_info.png", "info"),
                                                                                                                                                                                                                                                                                                                    `HSpacing (2)
                                                                                                                                                                                                                                                                                                                  )


                                                                                                                                                                                                                                                                                                              103.3.4. Info

                                                                                                                                                                                                                                                                                                              Returns UI term `Image() widget with an info-icon.

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • term - info icon

                                                                                                                                                                                                                                                                                                              103.3.5. Simple

                                                                                                                                                                                                                                                                                                              Function calls Icon::Image with default options

                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                              • string icon_type

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • term

                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                              • Icon for more information

                                                                                                                                                                                                                                                                                                              103.3.6. Warning

                                                                                                                                                                                                                                                                                                              Returns UI term `Image() widget with a warning-icon.

                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                              • term - warning icon

                                                                                                                                                                                                                                                                                                              103.4. Global Variables

                                                                                                                                                                                                                                                                                                              103.5. Module Requirements

                                                                                                                                                                                                                                                                                                              103.5.1. Module Imports

                                                                                                                                                                                                                                                                                                              • Directory

                                                                                                                                                                                                                                                                                                              103.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                104. Idedma

                                                                                                                                                                                                                                                                                                                Data for configuration of IDE DMA mode, input and output functions.

                                                                                                                                                                                                                                                                                                                104.1. Authors

                                                                                                                                                                                                                                                                                                                • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                104.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                • Export - Dump the IDE DMA settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                • Import - Get all IDE DMA settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                • Read - Read all DMA settings from the SCR

                                                                                                                                                                                                                                                                                                                • Set - Set module data

                                                                                                                                                                                                                                                                                                                • Summary - Create rich text description of the current configuration

                                                                                                                                                                                                                                                                                                                • Write - Update the SCR according to DMA settings

                                                                                                                                                                                                                                                                                                                • get_device_dma_status - Return actual DMA status of IDE device

                                                                                                                                                                                                                                                                                                                • get_ide_devices - Return information about all IDE devices

                                                                                                                                                                                                                                                                                                                • selected_mode - Get selected DMA mode, which will be saved and set in Write

                                                                                                                                                                                                                                                                                                                • set_dma - Set DMA of device

                                                                                                                                                                                                                                                                                                                • set_test_data - Set system configuration without reading values from system - for testing and screenshot mode

                                                                                                                                                                                                                                                                                                                • supported_dma_modes - Get list of supported DMA modes for selected device

                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                • dma_default_string - String with no change of DMA status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                • dma_off_string - String with DMA off status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                • dma_on_string - String with DMA on status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                104.3. Global Functions

                                                                                                                                                                                                                                                                                                                104.3.1. Export

                                                                                                                                                                                                                                                                                                                Dump the IDE DMA settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • list - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                104.3.2. Import

                                                                                                                                                                                                                                                                                                                Get all IDE DMA settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • list<map<string,any> > settings

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • boolean - True

                                                                                                                                                                                                                                                                                                                104.3.3. Read

                                                                                                                                                                                                                                                                                                                Read all DMA settings from the SCR

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                104.3.4. Set

                                                                                                                                                                                                                                                                                                                Set module data

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • list<map<string,any> > settings

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                104.3.5. Summary

                                                                                                                                                                                                                                                                                                                Create rich text description of the current configuration

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • boolean all

                                                                                                                                                                                                                                                                                                                • boolean richtext

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • string - summary text

                                                                                                                                                                                                                                                                                                                104.3.6. Write

                                                                                                                                                                                                                                                                                                                Update the SCR according to DMA settings

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                104.3.7. get_device_dma_status

                                                                                                                                                                                                                                                                                                                Return actual DMA status of IDE device

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • string device

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • string - true if DMA is on, false if DMA is off or nil on error

                                                                                                                                                                                                                                                                                                                104.3.8. get_ide_devices

                                                                                                                                                                                                                                                                                                                Return information about all IDE devices

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • list<map> - List of maps with information about all IDE devices

                                                                                                                                                                                                                                                                                                                104.3.9. selected_mode

                                                                                                                                                                                                                                                                                                                Get selected DMA mode, which will be saved and set in Write

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • string device

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • string - selected DMA mode ("on", "off", "nochange", or mode supported by hdparm - "udma5",...)

                                                                                                                                                                                                                                                                                                                104.3.10. set_dma

                                                                                                                                                                                                                                                                                                                Set DMA of device

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • string device

                                                                                                                                                                                                                                                                                                                • string dma_setting

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                104.3.11. set_test_data

                                                                                                                                                                                                                                                                                                                Set system configuration without reading values from system - for testing and screenshot mode

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                104.3.12. supported_dma_modes

                                                                                                                                                                                                                                                                                                                Get list of supported DMA modes for selected device

                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                • string device

                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                • list - supported DMA modes (["mdma2", "udma0", "udma1", "udma2"])

                                                                                                                                                                                                                                                                                                                104.4. Global Variables

                                                                                                                                                                                                                                                                                                                104.4.1. dma_default_string

                                                                                                                                                                                                                                                                                                                String with no change of DMA status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                104.4.2. dma_off_string

                                                                                                                                                                                                                                                                                                                String with DMA off status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                104.4.3. dma_on_string

                                                                                                                                                                                                                                                                                                                String with DMA on status text (For translators: translation can be long - text is used in the table in column "Required DMA mode" and "Current DMA mode")

                                                                                                                                                                                                                                                                                                                104.5. Module Requirements

                                                                                                                                                                                                                                                                                                                104.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                • Service

                                                                                                                                                                                                                                                                                                                104.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                • hwinfo/classnames.ycp

                                                                                                                                                                                                                                                                                                                105. ImageInstallation

                                                                                                                                                                                                                                                                                                                Support functions for installation via images

                                                                                                                                                                                                                                                                                                                105.1. Authors

                                                                                                                                                                                                                                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                105.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                  105.3. Global Functions

                                                                                                                                                                                                                                                                                                                  105.3.1. CleanTemporaryImage

                                                                                                                                                                                                                                                                                                                  UnDeploy an image temporarily (if possible, only for the FS images)

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • string id

                                                                                                                                                                                                                                                                                                                  • string target

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                  105.3.2. DeployImage

                                                                                                                                                                                                                                                                                                                  Deploy an image

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • string id

                                                                                                                                                                                                                                                                                                                  • string target

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                  105.3.3. DeployImageTemporarily

                                                                                                                                                                                                                                                                                                                  Deploy an image temporarily (just mount if possible)

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • string id

                                                                                                                                                                                                                                                                                                                  • string target

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                  105.3.4. DeployImages

                                                                                                                                                                                                                                                                                                                  Deploy all images

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • list<string> images

                                                                                                                                                                                                                                                                                                                  • string target

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                  105.3.5. FileSystemCopy

                                                                                                                                                                                                                                                                                                                  Copy a subtree, limit to a single filesystem

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • string from

                                                                                                                                                                                                                                                                                                                  • string to

                                                                                                                                                                                                                                                                                                                  • integer progress_start

                                                                                                                                                                                                                                                                                                                  • integer progress_finish

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                  105.3.6. FillUpImagesDetails

                                                                                                                                                                                                                                                                                                                  Loads non-mandatory details for every single selected image.

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                  105.3.7. FindImageSet

                                                                                                                                                                                                                                                                                                                  Find a set of images which suites selected patterns

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • list<string> patterns

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • boolean - true on success or when media does not contain any images

                                                                                                                                                                                                                                                                                                                  105.3.8. ImageOrder

                                                                                                                                                                                                                                                                                                                  Order of images to be deployed

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • list<string> - a list of images definint the order

                                                                                                                                                                                                                                                                                                                  105.3.9. ImagesToUse

                                                                                                                                                                                                                                                                                                                  Returns map with description which images will be used

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • map - with description

                                                                                                                                                                                                                                                                                                                  $[
                                                                                                                                                                                                                                                                                                                     "deploying_enabled" : boolean,
                                                                                                                                                                                                                                                                                                                     "images" : returned by GetCurrentImages()
                                                                                                                                                                                                                                                                                                                   ]
                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                                                                                                                  • GetCurrentImages()

                                                                                                                                                                                                                                                                                                                  105.3.10. SetRepo

                                                                                                                                                                                                                                                                                                                  Set the repository to get images from

                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                  • integer repo

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                  105.3.11. StoreAllChanges

                                                                                                                                                                                                                                                                                                                  Function stores all new/requested states of all handled/supported types.

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                                                                                                                  • all_supported_types

                                                                                                                                                                                                                                                                                                                  • objects_state

                                                                                                                                                                                                                                                                                                                  105.3.12. SwMgmtImage

                                                                                                                                                                                                                                                                                                                  Name of image containing software management metadata (if exists)

                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                  • string - image with sw mgmt metadata

                                                                                                                                                                                                                                                                                                                  105.4. Global Variables

                                                                                                                                                                                                                                                                                                                  105.5. Module Requirements

                                                                                                                                                                                                                                                                                                                  105.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                  • PackageCallbacks
                                                                                                                                                                                                                                                                                                                  • Packages
                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                  • ProductControl
                                                                                                                                                                                                                                                                                                                  • ProductFeatures
                                                                                                                                                                                                                                                                                                                  • Progress
                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                  • SlideShow
                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                  • XML

                                                                                                                                                                                                                                                                                                                  105.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                    106. Inetd

                                                                                                                                                                                                                                                                                                                    Data for configuration of inetd, input and output functions.

                                                                                                                                                                                                                                                                                                                    106.1. Authors

                                                                                                                                                                                                                                                                                                                    • Petr Hadraba <phadraba@suse.cz>

                                                                                                                                                                                                                                                                                                                    • Martin Lazar <mlazar@suse.cz>

                                                                                                                                                                                                                                                                                                                    106.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                    • Abort - Abort function

                                                                                                                                                                                                                                                                                                                    • AutoPackages - Return required packages for auto-installation FIXME: Need to make this return the needed packages during installation

                                                                                                                                                                                                                                                                                                                    • Export - Dump the inetd settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                    • Import - Get all inetd settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                    • MergeAyProfile - Merges AY profile items into a target list (defaults or system).

                                                                                                                                                                                                                                                                                                                    • MergeEditedWithSystem - This function solves differences between new (after installing requested packages) xinetd configuration and the configuration edited by the user. <pre> <b>In normal mode</b>: take the system services if it matches a service in the ui (ServicesMatch) use the ui data (not-installed ones are not a part of netd_conf, they only enter the table in mergexinetdconfs) Deleted services: OK. Added services: a separate pass needed </pre> TODO reduce the quadratic complexity.

                                                                                                                                                                                                                                                                                                                    • Modified - Data was modified? This function returnes modified variable.

                                                                                                                                                                                                                                                                                                                    • Read - Read all inetd settings

                                                                                                                                                                                                                                                                                                                    • SafeRemove - Removes keys from a map. Unlike the remove builtin, does not mind if the keys are already removed.

                                                                                                                                                                                                                                                                                                                    • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                    • Write - Write all inetd settings

                                                                                                                                                                                                                                                                                                                    • WriteOnly - Only Write settings

                                                                                                                                                                                                                                                                                                                    • addLine - add a line in DB

                                                                                                                                                                                                                                                                                                                    • changeLine - Change a line in DB

                                                                                                                                                                                                                                                                                                                    • deleteLine - delete line in netd_conf

                                                                                                                                                                                                                                                                                                                    • getChanged - Get only changed entries

                                                                                                                                                                                                                                                                                                                    • mergeAfterInstall - Merges autoinstall profile into the system configuration.

                                                                                                                                                                                                                                                                                                                    • mergeWithDefaults - merges imported changes with services defaults

                                                                                                                                                                                                                                                                                                                    • mkeServiceSummary - Create unsorted list of enabled services

                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                    • AbortFunction - Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                    • auto_mode - If autoinstallation mode (true), we do not want to install RPMs during configuration. Otherwise (false) we allow all.

                                                                                                                                                                                                                                                                                                                    • autoyast_initialized - Autoyast now does not initially call Import $[] anymore. But our design is so broken that we need it and will work hard to achieve it.

                                                                                                                                                                                                                                                                                                                    • last_created - This variable is used for new iid "generator"

                                                                                                                                                                                                                                                                                                                    • modified - Configuration was changed

                                                                                                                                                                                                                                                                                                                    • netd_conf - <pre> These variable holds inetd configuration. This is list of maps. Each map has the following structure: $[ "comment": String, "comment_inside": String, // this is agent internal "enabled": boolean, "group": String, "user": String, "iid": String, "protocol": String, "rpc_version": String, "server": String, "server_args": String, "service": String, "socket_type": String, "unparsed": String, // agent internal "wait": boolean ] </pre>

                                                                                                                                                                                                                                                                                                                    • netd_status - Is xinetd running? These variables contains return values from Service::Status() calls.

                                                                                                                                                                                                                                                                                                                    • proposal_valid - used in unused module inetd_proposal.ycp. This will be removed

                                                                                                                                                                                                                                                                                                                    • write_only - For autoinstallation Write() process. Write_only means that the service will not be actually started, because it is done by init later. But also that the service data are only a patch to be applied to the system.

                                                                                                                                                                                                                                                                                                                    106.3. Global Functions

                                                                                                                                                                                                                                                                                                                    106.3.1. Abort

                                                                                                                                                                                                                                                                                                                    Abort function

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - If AbortFunction not defined, returnes false

                                                                                                                                                                                                                                                                                                                    106.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                    Return required packages for auto-installation FIXME: Need to make this return the needed packages during installation

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                    106.3.3. Export

                                                                                                                                                                                                                                                                                                                    Dump the inetd settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                    106.3.4. Import

                                                                                                                                                                                                                                                                                                                    Get all inetd settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                    106.3.5. MergeAyProfile

                                                                                                                                                                                                                                                                                                                    Merges AY profile items into a target list (defaults or system).

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • services_t target

                                                                                                                                                                                                                                                                                                                    • services_t changes

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • services_t - merged list of services

                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                    • <a href="../autoyast_proto.xhtml">autoyast docs</a>.

                                                                                                                                                                                                                                                                                                                    106.3.6. MergeEditedWithSystem

                                                                                                                                                                                                                                                                                                                    This function solves differences between new (after installing requested packages) xinetd configuration and the configuration edited by the user. <pre> <b>In normal mode</b>: take the system services if it matches a service in the ui (ServicesMatch) use the ui data (not-installed ones are not a part of netd_conf, they only enter the table in mergexinetdconfs) Deleted services: OK. Added services: a separate pass needed </pre> TODO reduce the quadratic complexity.

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • services_t system_conf

                                                                                                                                                                                                                                                                                                                    • services_t edited_conf

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • services_t - Returnes new solved xinetd configuration (ready for Write()).

                                                                                                                                                                                                                                                                                                                    106.3.7. Modified

                                                                                                                                                                                                                                                                                                                    Data was modified? This function returnes modified variable.

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - true if modified

                                                                                                                                                                                                                                                                                                                    106.3.8. Read

                                                                                                                                                                                                                                                                                                                    Read all inetd settings

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                    106.3.9. SafeRemove

                                                                                                                                                                                                                                                                                                                    Removes keys from a map. Unlike the remove builtin, does not mind if the keys are already removed.

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • map m

                                                                                                                                                                                                                                                                                                                    • list keys

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • map - the map without the specified keys

                                                                                                                                                                                                                                                                                                                    106.3.10. Summary

                                                                                                                                                                                                                                                                                                                    Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                    106.3.11. Write

                                                                                                                                                                                                                                                                                                                    Write all inetd settings

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                    106.3.12. WriteOnly

                                                                                                                                                                                                                                                                                                                    Only Write settings

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                    106.3.13. addLine

                                                                                                                                                                                                                                                                                                                    add a line in DB

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • service_t new_line

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                    106.3.14. changeLine

                                                                                                                                                                                                                                                                                                                    Change a line in DB

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • service_t new_line

                                                                                                                                                                                                                                                                                                                    • any line_number

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                    106.3.15. deleteLine

                                                                                                                                                                                                                                                                                                                    delete line in netd_conf

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • any line_number

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                    106.3.16. getChanged

                                                                                                                                                                                                                                                                                                                    Get only changed entries

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • services_t config

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • services_t - Returnse list of changes only

                                                                                                                                                                                                                                                                                                                    106.3.17. mergeAfterInstall

                                                                                                                                                                                                                                                                                                                    Merges autoinstall profile into the system configuration.

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • services_t system_c

                                                                                                                                                                                                                                                                                                                    • services_t user_c

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • services_t - Returnes new solved xinetd configuration (ready for Write()).

                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                    • MergeAyProfile

                                                                                                                                                                                                                                                                                                                    106.3.18. mergeWithDefaults

                                                                                                                                                                                                                                                                                                                    merges imported changes with services defaults

                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                    • services_t changes

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • services_t - complete configuration with user changes

                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                    • MergeAyProfile

                                                                                                                                                                                                                                                                                                                    106.3.19. mkeServiceSummary

                                                                                                                                                                                                                                                                                                                    Create unsorted list of enabled services

                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                    • string - Returnes string with RichText-formated list

                                                                                                                                                                                                                                                                                                                    106.4. Global Variables

                                                                                                                                                                                                                                                                                                                    106.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                                    Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                    106.4.2. auto_mode

                                                                                                                                                                                                                                                                                                                    If autoinstallation mode (true), we do not want to install RPMs during configuration. Otherwise (false) we allow all.

                                                                                                                                                                                                                                                                                                                    106.4.3. autoyast_initialized

                                                                                                                                                                                                                                                                                                                    Autoyast now does not initially call Import $[] anymore. But our design is so broken that we need it and will work hard to achieve it.

                                                                                                                                                                                                                                                                                                                    106.4.4. last_created

                                                                                                                                                                                                                                                                                                                    This variable is used for new iid "generator"

                                                                                                                                                                                                                                                                                                                    106.4.5. modified

                                                                                                                                                                                                                                                                                                                    Configuration was changed

                                                                                                                                                                                                                                                                                                                    106.4.6. netd_conf

                                                                                                                                                                                                                                                                                                                    <pre> These variable holds inetd configuration. This is list of maps. Each map has the following structure: $[ "comment": String, "comment_inside": String, // this is agent internal "enabled": boolean, "group": String, "user": String, "iid": String, "protocol": String, "rpc_version": String, "server": String, "server_args": String, "service": String, "socket_type": String, "unparsed": String, // agent internal "wait": boolean ] </pre>

                                                                                                                                                                                                                                                                                                                    106.4.7. netd_status

                                                                                                                                                                                                                                                                                                                    Is xinetd running? These variables contains return values from Service::Status() calls.

                                                                                                                                                                                                                                                                                                                    106.4.8. proposal_valid

                                                                                                                                                                                                                                                                                                                    used in unused module inetd_proposal.ycp. This will be removed

                                                                                                                                                                                                                                                                                                                    106.4.9. write_only

                                                                                                                                                                                                                                                                                                                    For autoinstallation Write() process. Write_only means that the service will not be actually started, because it is done by init later. But also that the service data are only a patch to be applied to the system.

                                                                                                                                                                                                                                                                                                                    106.5. Module Requirements

                                                                                                                                                                                                                                                                                                                    106.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                    • String
                                                                                                                                                                                                                                                                                                                    • Summary
                                                                                                                                                                                                                                                                                                                    • XVersion

                                                                                                                                                                                                                                                                                                                    106.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                    • inetd/default_conf_xinetd.ycp
                                                                                                                                                                                                                                                                                                                    • inetd/routines.ycp

                                                                                                                                                                                                                                                                                                                    107. InitHWinfo

                                                                                                                                                                                                                                                                                                                    107.1. Authors

                                                                                                                                                                                                                                                                                                                    • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                    107.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                      107.3. Global Functions

                                                                                                                                                                                                                                                                                                                      107.3.1. DetectedHardware

                                                                                                                                                                                                                                                                                                                      Detect all hardware present in the system

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • boolean force

                                                                                                                                                                                                                                                                                                                      • block<boolean> abort

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • list<map> - list of maps - detected hardware items ()

                                                                                                                                                                                                                                                                                                                      107.3.2. Initialize

                                                                                                                                                                                                                                                                                                                      Start hardware detection (only CPU and main memory)

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • boolean force

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                      107.3.3. MakeProposal

                                                                                                                                                                                                                                                                                                                      Return short system description

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • boolean reset

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • list<string> - (string) list of hardware desciptions

                                                                                                                                                                                                                                                                                                                      107.4. Global Variables

                                                                                                                                                                                                                                                                                                                      107.5. Module Requirements

                                                                                                                                                                                                                                                                                                                      107.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                      • Arch
                                                                                                                                                                                                                                                                                                                      • Confirm
                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                      • String
                                                                                                                                                                                                                                                                                                                      • SystemSettings

                                                                                                                                                                                                                                                                                                                      107.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                      • hwinfo/routines.ycp

                                                                                                                                                                                                                                                                                                                      108. Initrd

                                                                                                                                                                                                                                                                                                                      functions for initial ramdisk setup and creation

                                                                                                                                                                                                                                                                                                                      108.1. Authors

                                                                                                                                                                                                                                                                                                                      • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                      108.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                      • AddModule - add module to ramdisk

                                                                                                                                                                                                                                                                                                                      • AdditionalParameters - Get additional parameters for mkinitrd

                                                                                                                                                                                                                                                                                                                      • Export - Export settigs to variable

                                                                                                                                                                                                                                                                                                                      • Import - import settings of initrd

                                                                                                                                                                                                                                                                                                                      • ListModules - List modules included in initrd

                                                                                                                                                                                                                                                                                                                      • Read - read seettings from sysconfig

                                                                                                                                                                                                                                                                                                                      • RemoveModule - remove module from list of initrd modules

                                                                                                                                                                                                                                                                                                                      • Reset - reset settings to empty list of modules

                                                                                                                                                                                                                                                                                                                      • SetAdditionalParameters - Set additional parameters for mkinitrd

                                                                                                                                                                                                                                                                                                                      • Update - Update read settings to new version of configuration files

                                                                                                                                                                                                                                                                                                                      • Write - write settings to sysconfig, rebuild initrd images

                                                                                                                                                                                                                                                                                                                      • errorWithLogPopup - Display error popup with log FIXME this is copy-paste from ../routines/popups.ycp

                                                                                                                                                                                                                                                                                                                      • getModulesToSkip - Get the list of modules which don't belong to initrd Initialize the list if was not initialized before according to the architecture

                                                                                                                                                                                                                                                                                                                      • setSplash - Set the -s parameter of mkinitrd

                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                      • changed - true if settings were changed and initrd needs to be rebuilt, false otherwise

                                                                                                                                                                                                                                                                                                                      108.3. Global Functions

                                                                                                                                                                                                                                                                                                                      108.3.1. AddModule

                                                                                                                                                                                                                                                                                                                      add module to ramdisk

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • string modname

                                                                                                                                                                                                                                                                                                                      • string modargs

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.2. AdditionalParameters

                                                                                                                                                                                                                                                                                                                      Get additional parameters for mkinitrd

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • string - additional mkinitrd parameters

                                                                                                                                                                                                                                                                                                                      108.3.3. Export

                                                                                                                                                                                                                                                                                                                      Export settigs to variable

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • map - of initrd settings

                                                                                                                                                                                                                                                                                                                      108.3.4. Import

                                                                                                                                                                                                                                                                                                                      import settings of initrd

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • map settings

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.5. ListModules

                                                                                                                                                                                                                                                                                                                      List modules included in initrd

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • list<string> - of strings with modulenames

                                                                                                                                                                                                                                                                                                                      108.3.6. Read

                                                                                                                                                                                                                                                                                                                      read seettings from sysconfig

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                      108.3.7. RemoveModule

                                                                                                                                                                                                                                                                                                                      remove module from list of initrd modules

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • string modname

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.8. Reset

                                                                                                                                                                                                                                                                                                                      reset settings to empty list of modules

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.9. SetAdditionalParameters

                                                                                                                                                                                                                                                                                                                      Set additional parameters for mkinitrd

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • string params

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.10. Update

                                                                                                                                                                                                                                                                                                                      Update read settings to new version of configuration files

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.11. Write

                                                                                                                                                                                                                                                                                                                      write settings to sysconfig, rebuild initrd images

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                      108.3.12. errorWithLogPopup

                                                                                                                                                                                                                                                                                                                      Display error popup with log FIXME this is copy-paste from ../routines/popups.ycp

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • string header

                                                                                                                                                                                                                                                                                                                      • string log

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.3.13. getModulesToSkip

                                                                                                                                                                                                                                                                                                                      Get the list of modules which don't belong to initrd Initialize the list if was not initialized before according to the architecture

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • list<string> - a list of modules

                                                                                                                                                                                                                                                                                                                      108.3.14. setSplash

                                                                                                                                                                                                                                                                                                                      Set the -s parameter of mkinitrd

                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                      • string vga

                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                      108.4. Global Variables

                                                                                                                                                                                                                                                                                                                      108.4.1. changed

                                                                                                                                                                                                                                                                                                                      true if settings were changed and initrd needs to be rebuilt, false otherwise

                                                                                                                                                                                                                                                                                                                      108.5. Module Requirements

                                                                                                                                                                                                                                                                                                                      108.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                      • Arch
                                                                                                                                                                                                                                                                                                                      • Directory
                                                                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                                                                      • Misc
                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                      • Stage

                                                                                                                                                                                                                                                                                                                      108.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                        109. InstData

                                                                                                                                                                                                                                                                                                                        Installation Data (variables, maps, probed info)

                                                                                                                                                                                                                                                                                                                        109.1. Authors

                                                                                                                                                                                                                                                                                                                        • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                        109.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                            109.3. Global Functions

                                                                                                                                                                                                                                                                                                                            109.4. Global Variables

                                                                                                                                                                                                                                                                                                                            109.5. Module Requirements

                                                                                                                                                                                                                                                                                                                            109.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                            • Directory

                                                                                                                                                                                                                                                                                                                            109.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                              110. InstExtensionImage

                                                                                                                                                                                                                                                                                                                              Functionality for downloading and merging extending images for the inst-sys

                                                                                                                                                                                                                                                                                                                              110.1. Authors

                                                                                                                                                                                                                                                                                                                              • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                              110.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                110.3. Global Functions

                                                                                                                                                                                                                                                                                                                                110.3.1. LoadExtension

                                                                                                                                                                                                                                                                                                                                Load a rpm package from the media into the inst-sys

                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                • string message

                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                110.3.2. UnLoadExtension

                                                                                                                                                                                                                                                                                                                                Remove given package from the inst-sys

                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                • string message

                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                110.4. Global Variables

                                                                                                                                                                                                                                                                                                                                110.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                110.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                • Linuxrc
                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                • Stage
                                                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                                                • URL

                                                                                                                                                                                                                                                                                                                                110.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                  111. InstShowInfo

                                                                                                                                                                                                                                                                                                                                  111.1. Authors

                                                                                                                                                                                                                                                                                                                                  • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                  • Purpose: Show /info.txt (if present) in a popup

                                                                                                                                                                                                                                                                                                                                  111.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                      111.3. Global Functions

                                                                                                                                                                                                                                                                                                                                      111.4. Global Variables

                                                                                                                                                                                                                                                                                                                                      111.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                      111.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                                                                                      • Report

                                                                                                                                                                                                                                                                                                                                      111.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                        112. InstURL

                                                                                                                                                                                                                                                                                                                                        112.1. Authors

                                                                                                                                                                                                                                                                                                                                        • Klaus Kaempf (kkaempf@suse.de)

                                                                                                                                                                                                                                                                                                                                        • Purpose: Convert /etc/install.inf data to URL

                                                                                                                                                                                                                                                                                                                                        112.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                          112.3. Global Functions

                                                                                                                                                                                                                                                                                                                                          112.3.1. HidePassword

                                                                                                                                                                                                                                                                                                                                          Hide Password

                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                          • string url

                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                          • string - new URL with hidden password

                                                                                                                                                                                                                                                                                                                                          112.3.2. RewriteCDUrl

                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                          • string url

                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                          112.3.3. installInf2Url

                                                                                                                                                                                                                                                                                                                                          Convert install.inf to a URL useable by the package manager

                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                          • string extra_dir

                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                          • string - new repository URL

                                                                                                                                                                                                                                                                                                                                          112.4. Global Variables

                                                                                                                                                                                                                                                                                                                                          112.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                          112.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                          • CheckMedia
                                                                                                                                                                                                                                                                                                                                          • Linuxrc
                                                                                                                                                                                                                                                                                                                                          • URL

                                                                                                                                                                                                                                                                                                                                          112.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                            113. Installation

                                                                                                                                                                                                                                                                                                                                            provide installation related information

                                                                                                                                                                                                                                                                                                                                            113.1. Authors

                                                                                                                                                                                                                                                                                                                                            • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                            113.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                            • boot - how we were booted (the type of the installation medium) /etc/install.inf: InstMode

                                                                                                                                                                                                                                                                                                                                            • no_x11 - somehow, no X11 was started no x11 or not enough memory for qt

                                                                                                                                                                                                                                                                                                                                            • text_fallback - no resources/packages for X11

                                                                                                                                                                                                                                                                                                                                            • x11_setup_needed - run X11 configuration after inital boot this is false in case of: installation via serial console installation via ssh installation via vnc

                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                            • image_installation - Installation is performed form image(s)

                                                                                                                                                                                                                                                                                                                                            • image_only - Installation is performed only from image(s), no additional RPM (de)installation

                                                                                                                                                                                                                                                                                                                                            • installedVersion - Version of the targetsystem (currently installed one).

                                                                                                                                                                                                                                                                                                                                            • license_accepted - The license has already been accepted, the respectiev radio button can be preselected

                                                                                                                                                                                                                                                                                                                                            • updateVersion - Version of system to update to (will be installed, or is just being installed).

                                                                                                                                                                                                                                                                                                                                            113.3. Global Functions

                                                                                                                                                                                                                                                                                                                                            113.3.1. boot

                                                                                                                                                                                                                                                                                                                                            how we were booted (the type of the installation medium) /etc/install.inf: InstMode

                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                            113.3.2. no_x11

                                                                                                                                                                                                                                                                                                                                            somehow, no X11 was started no x11 or not enough memory for qt

                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                            113.3.3. text_fallback

                                                                                                                                                                                                                                                                                                                                            no resources/packages for X11

                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                            113.3.4. x11_setup_needed

                                                                                                                                                                                                                                                                                                                                            run X11 configuration after inital boot this is false in case of: installation via serial console installation via ssh installation via vnc

                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                            113.4. Global Variables

                                                                                                                                                                                                                                                                                                                                            113.4.1. image_installation

                                                                                                                                                                                                                                                                                                                                            Installation is performed form image(s)

                                                                                                                                                                                                                                                                                                                                            113.4.2. image_only

                                                                                                                                                                                                                                                                                                                                            Installation is performed only from image(s), no additional RPM (de)installation

                                                                                                                                                                                                                                                                                                                                            113.4.3. installedVersion

                                                                                                                                                                                                                                                                                                                                            Version of the targetsystem (currently installed one).

                                                                                                                                                                                                                                                                                                                                            $[
                                                                                                                                                                                                                                                                                                                                               "name" : (string) "openSUSE",
                                                                                                                                                                                                                                                                                                                                               "version" : (string) "10.1",
                                                                                                                                                                                                                                                                                                                                               "nameandversion" : (string) "openSUSE 10.1",
                                                                                                                                                                                                                                                                                                                                               "major" : (integer) 10,
                                                                                                                                                                                                                                                                                                                                               "minor" : (integer) 1,
                                                                                                                                                                                                                                                                                                                                             ]

                                                                                                                                                                                                                                                                                                                                            113.4.4. license_accepted

                                                                                                                                                                                                                                                                                                                                            The license has already been accepted, the respectiev radio button can be preselected

                                                                                                                                                                                                                                                                                                                                            113.4.5. updateVersion

                                                                                                                                                                                                                                                                                                                                            Version of system to update to (will be installed, or is just being installed).

                                                                                                                                                                                                                                                                                                                                            $[
                                                                                                                                                                                                                                                                                                                                               "name" : (string) "openSUSE",
                                                                                                                                                                                                                                                                                                                                               "version" : (string) "11.0",
                                                                                                                                                                                                                                                                                                                                               "nameandversion" : (string) "openSUSE 11.0",
                                                                                                                                                                                                                                                                                                                                               "major" : (integer) 11,
                                                                                                                                                                                                                                                                                                                                               "minor" : (integer) 0,
                                                                                                                                                                                                                                                                                                                                             ]

                                                                                                                                                                                                                                                                                                                                            113.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                            113.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                            • Linuxrc
                                                                                                                                                                                                                                                                                                                                            • Stage

                                                                                                                                                                                                                                                                                                                                            113.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                              114. Instserver

                                                                                                                                                                                                                                                                                                                                              Installation Server settings, input and output functions

                                                                                                                                                                                                                                                                                                                                              114.1. Authors

                                                                                                                                                                                                                                                                                                                                              • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                              114.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                              • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                              • Export - Dump the instserver settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                              • Import - Get all instserver settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                              • Instserver - Constructor

                                                                                                                                                                                                                                                                                                                                              • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                              • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                              • Overview - Create an overview table with all configured data

                                                                                                                                                                                                                                                                                                                                              • Read - Read all instserver settings

                                                                                                                                                                                                                                                                                                                                              • SetupFTP - Setup FTP server

                                                                                                                                                                                                                                                                                                                                              • SetupHTTP - Setup HTTP server

                                                                                                                                                                                                                                                                                                                                              • SetupNFS - Setup NFS Server

                                                                                                                                                                                                                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                              • Write - Write all instserver settings

                                                                                                                                                                                                                                                                                                                                              • WriteSLPReg - Write SLP configuration

                                                                                                                                                                                                                                                                                                                                              • configSetup - Create XML Configuration

                                                                                                                                                                                                                                                                                                                                              • createLinks - Create links

                                                                                                                                                                                                                                                                                                                                              • createOrderFiles - Create yast directory with ordr/instorder files

                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                              114.3. Global Functions

                                                                                                                                                                                                                                                                                                                                              114.3.1. Abort

                                                                                                                                                                                                                                                                                                                                              Abort function

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.2. Export

                                                                                                                                                                                                                                                                                                                                              Dump the instserver settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                              114.3.3. Import

                                                                                                                                                                                                                                                                                                                                              Get all instserver settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean - True on success

                                                                                                                                                                                                                                                                                                                                              114.3.4. Instserver

                                                                                                                                                                                                                                                                                                                                              Constructor

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                              114.3.5. Modified

                                                                                                                                                                                                                                                                                                                                              Prototypes

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.6. Modified

                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                              114.3.7. Overview

                                                                                                                                                                                                                                                                                                                                              Create an overview table with all configured data

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • list - table items

                                                                                                                                                                                                                                                                                                                                              114.3.8. Read

                                                                                                                                                                                                                                                                                                                                              Read all instserver settings

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                              114.3.9. SetupFTP

                                                                                                                                                                                                                                                                                                                                              Setup FTP server

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • string dir

                                                                                                                                                                                                                                                                                                                                              • string ftproot

                                                                                                                                                                                                                                                                                                                                              • string ftpalias

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.10. SetupHTTP

                                                                                                                                                                                                                                                                                                                                              Setup HTTP server

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • string dir

                                                                                                                                                                                                                                                                                                                                              • string alias

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.11. SetupNFS

                                                                                                                                                                                                                                                                                                                                              Setup NFS Server

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • string dir

                                                                                                                                                                                                                                                                                                                                              • string options

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.12. Summary

                                                                                                                                                                                                                                                                                                                                              Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                              114.3.13. Write

                                                                                                                                                                                                                                                                                                                                              Write all instserver settings

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                              114.3.14. WriteSLPReg

                                                                                                                                                                                                                                                                                                                                              Write SLP configuration

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • map<string,any> cm

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                              114.3.15. configSetup

                                                                                                                                                                                                                                                                                                                                              Create XML Configuration

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                              114.3.16. createLinks

                                                                                                                                                                                                                                                                                                                                              Create links

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • string dir

                                                                                                                                                                                                                                                                                                                                              • string product

                                                                                                                                                                                                                                                                                                                                              • list<string> files

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • list<string>

                                                                                                                                                                                                                                                                                                                                              114.3.17. createOrderFiles

                                                                                                                                                                                                                                                                                                                                              Create yast directory with ordr/instorder files

                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                              • string dir

                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                              • boolean - booelan

                                                                                                                                                                                                                                                                                                                                              114.4. Global Variables

                                                                                                                                                                                                                                                                                                                                              114.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                                                              Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                              114.4.2. modified

                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                              114.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                              114.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                              • Call
                                                                                                                                                                                                                                                                                                                                              • IP
                                                                                                                                                                                                                                                                                                                                              • Message
                                                                                                                                                                                                                                                                                                                                              • Package
                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                              • SLP
                                                                                                                                                                                                                                                                                                                                              • Service
                                                                                                                                                                                                                                                                                                                                              • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                              • Summary
                                                                                                                                                                                                                                                                                                                                              • XML

                                                                                                                                                                                                                                                                                                                                              114.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                              • instserver/routines.ycp

                                                                                                                                                                                                                                                                                                                                              115. Integer

                                                                                                                                                                                                                                                                                                                                              Integer routines

                                                                                                                                                                                                                                                                                                                                              115.1. Authors

                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                              115.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                              • Clamp - Clamps the integer i.

                                                                                                                                                                                                                                                                                                                                              • IsPowerOfTwo - Checks whether i is a power of two. That is 1, 2, 4, 8, ... .

                                                                                                                                                                                                                                                                                                                                              • Max - Returns the highest integer in values.

                                                                                                                                                                                                                                                                                                                                              • Min - Returns the smallest integer in values.

                                                                                                                                                                                                                                                                                                                                              • Range - Generate a list<integer> with the integers from 0 to stop - 1.

                                                                                                                                                                                                                                                                                                                                              • RangeFrom - Generate a list<integer> with the integers from start to stop - 1.

                                                                                                                                                                                                                                                                                                                                              • Sum - Calculates the sum of values.

                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                115.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                115.3.1. Clamp

                                                                                                                                                                                                                                                                                                                                                Clamps the integer i.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • integer i

                                                                                                                                                                                                                                                                                                                                                • integer min

                                                                                                                                                                                                                                                                                                                                                • integer max

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                115.3.2. IsPowerOfTwo

                                                                                                                                                                                                                                                                                                                                                Checks whether i is a power of two. That is 1, 2, 4, 8, ... .

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • integer i

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                115.3.3. Max

                                                                                                                                                                                                                                                                                                                                                Returns the highest integer in values.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • list<integer> values

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                115.3.4. Min

                                                                                                                                                                                                                                                                                                                                                Returns the smallest integer in values.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • list<integer> values

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                115.3.5. Range

                                                                                                                                                                                                                                                                                                                                                Generate a list<integer> with the integers from 0 to stop - 1.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • integer stop

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • list<integer>

                                                                                                                                                                                                                                                                                                                                                115.3.6. RangeFrom

                                                                                                                                                                                                                                                                                                                                                Generate a list<integer> with the integers from start to stop - 1.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • integer start

                                                                                                                                                                                                                                                                                                                                                • integer stop

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • list<integer>

                                                                                                                                                                                                                                                                                                                                                115.3.7. Sum

                                                                                                                                                                                                                                                                                                                                                Calculates the sum of values.

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • list<integer> values

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                115.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                115.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                116. Internet

                                                                                                                                                                                                                                                                                                                                                Internet connection and YOU during the installation

                                                                                                                                                                                                                                                                                                                                                116.1. Authors

                                                                                                                                                                                                                                                                                                                                                • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                116.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                • Connected - Test if the interface is connected

                                                                                                                                                                                                                                                                                                                                                • GetDevices - Used if NetworkInterfaces cannot find anything (usually because NM runs) Calls ip

                                                                                                                                                                                                                                                                                                                                                • Reset - Reset values.

                                                                                                                                                                                                                                                                                                                                                • SetDemand - Set dial-on-demand

                                                                                                                                                                                                                                                                                                                                                • ShutdownAllLocalDHCPClients - DANGEROUS function. Searches for all standard PID files of dhcpcd, then kills all dhcpcds running (first SIGHUP, then SIGKILL). Works via WFM (only for local dhcpcd).

                                                                                                                                                                                                                                                                                                                                                • Start - Start the fastest interface

                                                                                                                                                                                                                                                                                                                                                • Status - Status of the fastest interface

                                                                                                                                                                                                                                                                                                                                                • Stop - Stop the fastest interface

                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                • device - Values for selected connection.

                                                                                                                                                                                                                                                                                                                                                • do_test - Flag to remember if user wants to run internet test

                                                                                                                                                                                                                                                                                                                                                • do_you - Flag to remember if you should be started

                                                                                                                                                                                                                                                                                                                                                • suse_register - Flag to remember if user wants to run suse register

                                                                                                                                                                                                                                                                                                                                                116.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                116.3.1. Connected

                                                                                                                                                                                                                                                                                                                                                Test if the interface is connected

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean - true if connected

                                                                                                                                                                                                                                                                                                                                                116.3.2. GetDevices

                                                                                                                                                                                                                                                                                                                                                Used if NetworkInterfaces cannot find anything (usually because NM runs) Calls ip

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • list<string> - eg. ["eth0", "eth1"]

                                                                                                                                                                                                                                                                                                                                                116.3.3. Reset

                                                                                                                                                                                                                                                                                                                                                Reset values.

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                116.3.4. SetDemand

                                                                                                                                                                                                                                                                                                                                                Set dial-on-demand

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • boolean demand

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                116.3.5. ShutdownAllLocalDHCPClients

                                                                                                                                                                                                                                                                                                                                                DANGEROUS function. Searches for all standard PID files of dhcpcd, then kills all dhcpcds running (first SIGHUP, then SIGKILL). Works via WFM (only for local dhcpcd).

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                116.3.6. Start

                                                                                                                                                                                                                                                                                                                                                Start the fastest interface

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • string log

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean - true if successful started

                                                                                                                                                                                                                                                                                                                                                116.3.7. Status

                                                                                                                                                                                                                                                                                                                                                Status of the fastest interface

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean - true if interface is up (which is not equal to connected)

                                                                                                                                                                                                                                                                                                                                                116.3.8. Stop

                                                                                                                                                                                                                                                                                                                                                Stop the fastest interface

                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                • string log

                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                • boolean - true if successful stopped

                                                                                                                                                                                                                                                                                                                                                116.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                116.4.1. device

                                                                                                                                                                                                                                                                                                                                                Values for selected connection.

                                                                                                                                                                                                                                                                                                                                                116.4.2. do_test

                                                                                                                                                                                                                                                                                                                                                Flag to remember if user wants to run internet test

                                                                                                                                                                                                                                                                                                                                                116.4.3. do_you

                                                                                                                                                                                                                                                                                                                                                Flag to remember if you should be started

                                                                                                                                                                                                                                                                                                                                                116.4.4. suse_register

                                                                                                                                                                                                                                                                                                                                                Flag to remember if user wants to run suse register

                                                                                                                                                                                                                                                                                                                                                116.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                116.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                • Map
                                                                                                                                                                                                                                                                                                                                                • NetworkService
                                                                                                                                                                                                                                                                                                                                                • Service

                                                                                                                                                                                                                                                                                                                                                116.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                  117. InternetDevices

                                                                                                                                                                                                                                                                                                                                                  Internet connection and YOU during the installation

                                                                                                                                                                                                                                                                                                                                                  117.1. Authors

                                                                                                                                                                                                                                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                  • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                  117.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                  • FindFastest - Find the fastest connection to the Internet

                                                                                                                                                                                                                                                                                                                                                  • SetDevice - Set device from argument as default network device

                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                    117.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                    117.3.1. FindFastest

                                                                                                                                                                                                                                                                                                                                                    Find the fastest connection to the Internet

                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                    • boolean - true if a "good" connection was found

                                                                                                                                                                                                                                                                                                                                                    117.3.2. SetDevice

                                                                                                                                                                                                                                                                                                                                                    Set device from argument as default network device

                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                    • string dev

                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                    117.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                    117.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                    117.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                    • Internet
                                                                                                                                                                                                                                                                                                                                                    • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                    • Provider

                                                                                                                                                                                                                                                                                                                                                    117.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                      118. Irda

                                                                                                                                                                                                                                                                                                                                                      Irda settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                      118.1. Authors

                                                                                                                                                                                                                                                                                                                                                      • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                      118.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                      • Read - Read all irda settings

                                                                                                                                                                                                                                                                                                                                                      • ReadSysconfig - Read irda settings from /etc/sysconfig/irda

                                                                                                                                                                                                                                                                                                                                                      • Write - Write all irda settings

                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                      • max_baud_rate - Maximum baud rate for the IrDA serial port

                                                                                                                                                                                                                                                                                                                                                      • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                      • port - serial port used for irda

                                                                                                                                                                                                                                                                                                                                                      • start - Should irda be started?

                                                                                                                                                                                                                                                                                                                                                      118.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                      118.3.1. Read

                                                                                                                                                                                                                                                                                                                                                      Read all irda settings

                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                      118.3.2. ReadSysconfig

                                                                                                                                                                                                                                                                                                                                                      Read irda settings from /etc/sysconfig/irda

                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                      • boolean - true when file exists

                                                                                                                                                                                                                                                                                                                                                      118.3.3. Write

                                                                                                                                                                                                                                                                                                                                                      Write all irda settings

                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                      118.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                      118.4.1. max_baud_rate

                                                                                                                                                                                                                                                                                                                                                      Maximum baud rate for the IrDA serial port

                                                                                                                                                                                                                                                                                                                                                      118.4.2. modified

                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                      118.4.3. port

                                                                                                                                                                                                                                                                                                                                                      serial port used for irda

                                                                                                                                                                                                                                                                                                                                                      118.4.4. start

                                                                                                                                                                                                                                                                                                                                                      Should irda be started?

                                                                                                                                                                                                                                                                                                                                                      118.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                      118.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                      • FileUtils
                                                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                                                      • Service

                                                                                                                                                                                                                                                                                                                                                      118.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                        119. IscsiClient

                                                                                                                                                                                                                                                                                                                                                        IscsiClient settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                        119.1. Authors

                                                                                                                                                                                                                                                                                                                                                        • Michal Zugec <mzugec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                        119.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                        • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                        • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                        • Export - Dump the iscsi-client settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                        • Import - Get all iscsi-client settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                        • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                        • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                        • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                        • Read - Read all iscsi-client settings

                                                                                                                                                                                                                                                                                                                                                        • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                        • Write - Write all iscsi-client settings

                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                        • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                        • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                        • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                        119.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                        119.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                        Abort function

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                        119.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                        Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                        119.3.3. Export

                                                                                                                                                                                                                                                                                                                                                        Dump the iscsi-client settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                        119.3.4. Import

                                                                                                                                                                                                                                                                                                                                                        Get all iscsi-client settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                        119.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                        Prototypes

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                        119.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                        119.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                        Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • list - table items

                                                                                                                                                                                                                                                                                                                                                        119.3.8. Read

                                                                                                                                                                                                                                                                                                                                                        Read all iscsi-client settings

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                        119.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                        Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                        119.3.10. Write

                                                                                                                                                                                                                                                                                                                                                        Write all iscsi-client settings

                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                        119.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                        119.4.1. modified

                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                        119.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                        119.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                        Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                        119.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                        119.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                        • Confirm
                                                                                                                                                                                                                                                                                                                                                        • IscsiClientLib
                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                        • Message
                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                        • NetworkService
                                                                                                                                                                                                                                                                                                                                                        • Package
                                                                                                                                                                                                                                                                                                                                                        • Packages
                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                        • Summary

                                                                                                                                                                                                                                                                                                                                                        119.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                          120. IscsiClientLib

                                                                                                                                                                                                                                                                                                                                                          120.1. Authors

                                                                                                                                                                                                                                                                                                                                                            120.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                            • getiBFT - get iBFT (available only on some special hardware)

                                                                                                                                                                                                                                                                                                                                                            • writeInitiatorName - write InitiatorName, create backup from previous if needed

                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                              120.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                              120.3.1. getiBFT

                                                                                                                                                                                                                                                                                                                                                              get iBFT (available only on some special hardware)

                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                              • map<string, any>

                                                                                                                                                                                                                                                                                                                                                              120.3.2. writeInitiatorName

                                                                                                                                                                                                                                                                                                                                                              write InitiatorName, create backup from previous if needed

                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                              • string new_value

                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                              120.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                              120.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                              120.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                              • Hostname
                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                              • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                              • Service
                                                                                                                                                                                                                                                                                                                                                              • Stage

                                                                                                                                                                                                                                                                                                                                                              120.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                121. IscsiServer

                                                                                                                                                                                                                                                                                                                                                                IscsiServer settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                121.1. Authors

                                                                                                                                                                                                                                                                                                                                                                • Michal Zugec <mzugec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                121.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                • Export - Dump the iscsi-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                • Import - Get all iscsi-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                • Read - Read all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                • Write - Write all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                121.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                121.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                Abort function

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                121.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                121.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                Dump the iscsi-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                121.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                Get all iscsi-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                121.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                Prototypes

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                121.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                121.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • list - table items

                                                                                                                                                                                                                                                                                                                                                                121.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                Read all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                121.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                121.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                Write all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                121.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                121.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                121.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                121.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                121.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                121.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                • Confirm
                                                                                                                                                                                                                                                                                                                                                                • IscsiServerFunctions
                                                                                                                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                • NetworkService
                                                                                                                                                                                                                                                                                                                                                                • Package
                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                • Service
                                                                                                                                                                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                                                                                                                                                                121.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                  122. isnsServer

                                                                                                                                                                                                                                                                                                                                                                  IsnsServer settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                  122.1. Authors

                                                                                                                                                                                                                                                                                                                                                                  • Michal Zugec <mzugec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                  122.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                  • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                  • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                  • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                  • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                  • Read - Read all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                  • Write - Write all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                  • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                  • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                  • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                  122.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                  122.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                  Abort function

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                  122.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                  Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                  122.3.3. Modified

                                                                                                                                                                                                                                                                                                                                                                  Prototypes

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                  122.3.4. Modified

                                                                                                                                                                                                                                                                                                                                                                  Data was modified?

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                  122.3.5. Read

                                                                                                                                                                                                                                                                                                                                                                  Read all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                  122.3.6. Write

                                                                                                                                                                                                                                                                                                                                                                  Write all iscsi-server settings

                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                  122.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                  122.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                  Data was modified?

                                                                                                                                                                                                                                                                                                                                                                  122.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                  122.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                  Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                  122.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                  122.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                  • Confirm
                                                                                                                                                                                                                                                                                                                                                                  • Map
                                                                                                                                                                                                                                                                                                                                                                  • Message
                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                  • Package
                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                  • Progress
                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                  • Service
                                                                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                                                                  • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                  • Summary

                                                                                                                                                                                                                                                                                                                                                                  122.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                    123. Joystick

                                                                                                                                                                                                                                                                                                                                                                    Joystick data

                                                                                                                                                                                                                                                                                                                                                                    123.1. Authors

                                                                                                                                                                                                                                                                                                                                                                    • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                    123.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                    • Changed - Return configuration status

                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the joystick settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all joystick settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                    • Read - Read all joystick settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                    • RequiredKernelModules - Get list of all required joystick kernel modules

                                                                                                                                                                                                                                                                                                                                                                    • SaveOneJoystick - Update the SCR of the one joystick

                                                                                                                                                                                                                                                                                                                                                                    • StartAndEnable - Start joystick service and insserv it

                                                                                                                                                                                                                                                                                                                                                                    • Stop - Stop joystick service

                                                                                                                                                                                                                                                                                                                                                                    • Summary - Build a textual summary that can be used e.g. in inst_hw_config () or something similar.

                                                                                                                                                                                                                                                                                                                                                                    • Write - Update the SCR according to joystick settings

                                                                                                                                                                                                                                                                                                                                                                    • WriteConfig - Write sysconfig values (flush)

                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                    • joystick - joystick config datastructure (list of maps)

                                                                                                                                                                                                                                                                                                                                                                    123.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                    123.3.1. Changed

                                                                                                                                                                                                                                                                                                                                                                    Return configuration status

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if configuration was changed

                                                                                                                                                                                                                                                                                                                                                                    123.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                    Dump the joystick settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • list - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                    123.3.3. Import

                                                                                                                                                                                                                                                                                                                                                                    Get all joystick settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                    • list settings

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                    123.3.4. Read

                                                                                                                                                                                                                                                                                                                                                                    Read all joystick settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                    • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                    123.3.5. RequiredKernelModules

                                                                                                                                                                                                                                                                                                                                                                    Get list of all required joystick kernel modules

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • list<string> - list of modules

                                                                                                                                                                                                                                                                                                                                                                    123.3.6. SaveOneJoystick

                                                                                                                                                                                                                                                                                                                                                                    Update the SCR of the one joystick

                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                    • integer pos

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                    123.3.7. StartAndEnable

                                                                                                                                                                                                                                                                                                                                                                    Start joystick service and insserv it

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                    123.3.8. Stop

                                                                                                                                                                                                                                                                                                                                                                    Stop joystick service

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                    123.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                    Build a textual summary that can be used e.g. in inst_hw_config () or something similar.

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • string - Summary of the configuration.

                                                                                                                                                                                                                                                                                                                                                                    123.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                    Update the SCR according to joystick settings

                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                    • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                    123.3.11. WriteConfig

                                                                                                                                                                                                                                                                                                                                                                    Write sysconfig values (flush)

                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                    123.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                    123.4.1. joystick

                                                                                                                                                                                                                                                                                                                                                                    joystick config datastructure (list of maps)

                                                                                                                                                                                                                                                                                                                                                                    123.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                    123.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                    • Service

                                                                                                                                                                                                                                                                                                                                                                    123.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                      124. Kdump

                                                                                                                                                                                                                                                                                                                                                                      124.1. Authors

                                                                                                                                                                                                                                                                                                                                                                        124.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                        • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                        • CheckPackages - Check if user enabled kdump if no deselect packages for installing if yes add necessary packages for installation

                                                                                                                                                                                                                                                                                                                                                                        • Export - Export kdump settings to a map

                                                                                                                                                                                                                                                                                                                                                                        • GetModified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                        • GetModified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                        • Import - Import settings from a map

                                                                                                                                                                                                                                                                                                                                                                        • Propose - Propose all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        • Read - Read all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        • SetModified - Set data was modified

                                                                                                                                                                                                                                                                                                                                                                        • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                        • Write - Write all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                        124.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                        124.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                        Abort function

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                        124.3.2. CheckPackages

                                                                                                                                                                                                                                                                                                                                                                        Check if user enabled kdump if no deselect packages for installing if yes add necessary packages for installation

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                        124.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                        Export kdump settings to a map

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • map - kdump settings

                                                                                                                                                                                                                                                                                                                                                                        124.3.4. GetModified

                                                                                                                                                                                                                                                                                                                                                                        Prototypes

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                        124.3.5. GetModified

                                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                        124.3.6. Import

                                                                                                                                                                                                                                                                                                                                                                        Import settings from a map

                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                        124.3.7. Propose

                                                                                                                                                                                                                                                                                                                                                                        Propose all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                        124.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                        Read all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                        124.3.9. SetModified

                                                                                                                                                                                                                                                                                                                                                                        Set data was modified

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                        124.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                        Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • list<string> - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                        124.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                        Write all kdump settings

                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                        124.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                        124.4.1. DEFAULT_CONFIG

                                                                                                                                                                                                                                                                                                                                                                        map of deafult values for options in UI

                                                                                                                                                                                                                                                                                                                                                                        124.4.2. KDUMP_SETTINGS

                                                                                                                                                                                                                                                                                                                                                                        map <string, string > of kdump settings

                                                                                                                                                                                                                                                                                                                                                                        124.4.3. actual_boot_section

                                                                                                                                                                                                                                                                                                                                                                        String option identify which boot section was used during boot process

                                                                                                                                                                                                                                                                                                                                                                        124.4.4. add_crashkernel_param

                                                                                                                                                                                                                                                                                                                                                                        Boolean option indicates add kernel param "crashkernel"

                                                                                                                                                                                                                                                                                                                                                                        124.4.5. alocated_memory

                                                                                                                                                                                                                                                                                                                                                                        String option for alocate of memory for boot param "crashkernel"

                                                                                                                                                                                                                                                                                                                                                                        124.4.6. available_partitions

                                                                                                                                                                                                                                                                                                                                                                        List of available partiotions with known partition

                                                                                                                                                                                                                                                                                                                                                                        124.4.7. crashkernel_param_value

                                                                                                                                                                                                                                                                                                                                                                        String option indicates value of kernel parameter "crashkernel"

                                                                                                                                                                                                                                                                                                                                                                        124.4.8. import_called

                                                                                                                                                                                                                                                                                                                                                                        Boolean option indicates that Import() was called and data was proposed

                                                                                                                                                                                                                                                                                                                                                                        124.4.9. kdump_packages

                                                                                                                                                                                                                                                                                                                                                                        list of packages for installation

                                                                                                                                                                                                                                                                                                                                                                        124.4.10. modified

                                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                                        124.4.11. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                        124.4.12. propose_called

                                                                                                                                                                                                                                                                                                                                                                        true if propose was called

                                                                                                                                                                                                                                                                                                                                                                        124.4.13. total_memory

                                                                                                                                                                                                                                                                                                                                                                        Total available memory [MB]

                                                                                                                                                                                                                                                                                                                                                                        124.4.14. uknown_fs_partitions

                                                                                                                                                                                                                                                                                                                                                                        List of available partiotions without filesystem or with uknown

                                                                                                                                                                                                                                                                                                                                                                        124.4.15. write_only

                                                                                                                                                                                                                                                                                                                                                                        Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                        124.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                        124.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                        • BootCommon
                                                                                                                                                                                                                                                                                                                                                                        • BootCommon
                                                                                                                                                                                                                                                                                                                                                                        • Bootloader
                                                                                                                                                                                                                                                                                                                                                                        • FileUtils
                                                                                                                                                                                                                                                                                                                                                                        • Map
                                                                                                                                                                                                                                                                                                                                                                        • Map
                                                                                                                                                                                                                                                                                                                                                                        • Message
                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                        • PackagesProposal
                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                        • ProductControl
                                                                                                                                                                                                                                                                                                                                                                        • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                                        • Summary

                                                                                                                                                                                                                                                                                                                                                                        124.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                          125. Kerberos

                                                                                                                                                                                                                                                                                                                                                                          Data for configuration of kerberos-client, i/o functions.

                                                                                                                                                                                                                                                                                                                                                                          125.1. Authors

                                                                                                                                                                                                                                                                                                                                                                          • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                          125.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                          • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                          • Export - Dump the Kerberos settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                          • Import - Get all the Kerberos configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                          • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                          • Read - Reads Kerberos settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                          • ReadFile - Deprecated variant to ReadKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          • ReadKrb5ConfValue - Reads the item value from the /etc/krb5.conf via ini agent If the item doesn't exist, returns the default value

                                                                                                                                                                                                                                                                                                                                                                          • ReadKrb5ConfValues - Reads the item values from the /etc/krb5.conf via ini agent If the item doesn't exist, returns the default value

                                                                                                                                                                                                                                                                                                                                                                          • ShortSummary - Create a short textual summary

                                                                                                                                                                                                                                                                                                                                                                          • Summary - Create a textual summary

                                                                                                                                                                                                                                                                                                                                                                          • UpdatedArchPackages - Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                          • ValidateTimeEntries - Validation function for time-related values

                                                                                                                                                                                                                                                                                                                                                                          • Write - Saves Kerberos configuration. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                          • WriteFile - Deprecated variant to WriteKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          • WriteKrb5ConfValue - Write the item value to /etc/krb5.conf Do not write anything for empty and nil values

                                                                                                                                                                                                                                                                                                                                                                          • WriteKrb5ConfValues - Write list of values for given key to /etc/krb5.conf Do not write anything for empty and nil values

                                                                                                                                                                                                                                                                                                                                                                          • WriteKrb5ConfValuesAsString - Write (possible) multiple values of given key to /etc/krb5.conf

                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                          125.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                          125.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                          Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                          125.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                          Dump the Kerberos settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • map - with settings

                                                                                                                                                                                                                                                                                                                                                                          125.3.3. Import

                                                                                                                                                                                                                                                                                                                                                                          Get all the Kerberos configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                          125.3.4. Modified

                                                                                                                                                                                                                                                                                                                                                                          Data was modified?

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                          125.3.5. Read

                                                                                                                                                                                                                                                                                                                                                                          Reads Kerberos settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                          125.3.6. ReadFile

                                                                                                                                                                                                                                                                                                                                                                          Deprecated variant to ReadKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string def_value

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                          125.3.7. ReadKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          Reads the item value from the /etc/krb5.conf via ini agent If the item doesn't exist, returns the default value

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string def_value

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • string - the value

                                                                                                                                                                                                                                                                                                                                                                          125.3.8. ReadKrb5ConfValues

                                                                                                                                                                                                                                                                                                                                                                          Reads the item values from the /etc/krb5.conf via ini agent If the item doesn't exist, returns the default value

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string def_value

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • list<string> - string the values for given key

                                                                                                                                                                                                                                                                                                                                                                          125.3.9. ShortSummary

                                                                                                                                                                                                                                                                                                                                                                          Create a short textual summary

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                          125.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                          Create a textual summary

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                          125.3.11. UpdatedArchPackages

                                                                                                                                                                                                                                                                                                                                                                          Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • list<string>

                                                                                                                                                                                                                                                                                                                                                                          125.3.12. ValidateTimeEntries

                                                                                                                                                                                                                                                                                                                                                                          Validation function for time-related values

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • string key

                                                                                                                                                                                                                                                                                                                                                                          • string val

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                          125.3.13. Write

                                                                                                                                                                                                                                                                                                                                                                          Saves Kerberos configuration. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                          125.3.14. WriteFile

                                                                                                                                                                                                                                                                                                                                                                          Deprecated variant to WriteKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string value

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                          125.3.15. WriteKrb5ConfValue

                                                                                                                                                                                                                                                                                                                                                                          Write the item value to /etc/krb5.conf Do not write anything for empty and nil values

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string value

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - false when nothing was written, success of write otherwise

                                                                                                                                                                                                                                                                                                                                                                          125.3.16. WriteKrb5ConfValues

                                                                                                                                                                                                                                                                                                                                                                          Write list of values for given key to /etc/krb5.conf Do not write anything for empty and nil values

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • list<string> values

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean - false when nothing was written, success of write otherwise

                                                                                                                                                                                                                                                                                                                                                                          125.3.17. WriteKrb5ConfValuesAsString

                                                                                                                                                                                                                                                                                                                                                                          Write (possible) multiple values of given key to /etc/krb5.conf

                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                          • path path_to_value

                                                                                                                                                                                                                                                                                                                                                                          • string values

                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                          125.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                          125.4.1. ExpertSettings

                                                                                                                                                                                                                                                                                                                                                                          map with the settings configurable in the expert tabs

                                                                                                                                                                                                                                                                                                                                                                          125.4.2. required_packages

                                                                                                                                                                                                                                                                                                                                                                          Required packages for this module to operate

                                                                                                                                                                                                                                                                                                                                                                          125.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                          125.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                          • Arch
                                                                                                                                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                                                                                                                                          • Hostname
                                                                                                                                                                                                                                                                                                                                                                          • Label
                                                                                                                                                                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                                                                                                                                                                          • Package
                                                                                                                                                                                                                                                                                                                                                                          • Pam
                                                                                                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                                                                                                                                                                          • Stage
                                                                                                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                                                                                                          125.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                            126. Kernel

                                                                                                                                                                                                                                                                                                                                                                            Kernel related functions and data

                                                                                                                                                                                                                                                                                                                                                                            126.1. Authors

                                                                                                                                                                                                                                                                                                                                                                            • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                            • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                            126.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                              126.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                              126.3.1. AddCmdLine

                                                                                                                                                                                                                                                                                                                                                                              AddCmdLine ()

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string name

                                                                                                                                                                                                                                                                                                                                                                              • string arg

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                              • cmdLine

                                                                                                                                                                                                                                                                                                                                                                              126.3.2. AddModuleToLoad

                                                                                                                                                                                                                                                                                                                                                                              Add a kernel module to the list of modules to load after boot

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string name

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.3.3. ComputePackage

                                                                                                                                                                                                                                                                                                                                                                              Compute kernel package

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • string - selected kernel

                                                                                                                                                                                                                                                                                                                                                                              126.3.4. ComputePackages

                                                                                                                                                                                                                                                                                                                                                                              Compute kernel packages

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • list <string> - of selected kernel packages

                                                                                                                                                                                                                                                                                                                                                                              126.3.5. ComputePackagesForBase

                                                                                                                                                                                                                                                                                                                                                                              Compute kernel package for the specified base kernel package

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string base

                                                                                                                                                                                                                                                                                                                                                                              • boolean check_avail

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • list<string> - a list of all kernel packages (including the base package) that are to be installed together with the base package

                                                                                                                                                                                                                                                                                                                                                                              126.3.6. GetBinary

                                                                                                                                                                                                                                                                                                                                                                              Het the name of kernel binary under /boot

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • string - the name of the kernel binary

                                                                                                                                                                                                                                                                                                                                                                              126.3.7. GetCmdLine

                                                                                                                                                                                                                                                                                                                                                                              Get the kernel command line

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • string - the command line

                                                                                                                                                                                                                                                                                                                                                                              126.3.8. GetInformAboutKernelChange

                                                                                                                                                                                                                                                                                                                                                                              Get inform_about_kernel_change.

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                              126.3.9. GetPackages

                                                                                                                                                                                                                                                                                                                                                                              Get the list of kernel packages

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • list<string> - a list of kernel packages

                                                                                                                                                                                                                                                                                                                                                                              126.3.10. GetSuSEUpdate

                                                                                                                                                                                                                                                                                                                                                                              Check if suse_update kernel command line argument was passed

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if it was

                                                                                                                                                                                                                                                                                                                                                                              126.3.11. GetVgaType

                                                                                                                                                                                                                                                                                                                                                                              Get the vga= kernel parameter

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • string - the vga= kernel parameter

                                                                                                                                                                                                                                                                                                                                                                              126.3.12. ProbeKernel

                                                                                                                                                                                                                                                                                                                                                                              select kernel depending on architecture and system type.

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.3.13. RemoveModuleToLoad

                                                                                                                                                                                                                                                                                                                                                                              Remove a kernel module from the list of modules to load after boot

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string name

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.3.14. SaveModulesToLoad

                                                                                                                                                                                                                                                                                                                                                                              SaveModuleToLoad () save the sysconfig variable to the file

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                              126.3.15. SetCmdLine

                                                                                                                                                                                                                                                                                                                                                                              Set the kernel command line FIXME is heer because of bootloader module, should be removed

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string new_cmd_line

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.3.16. SetInformAboutKernelChange

                                                                                                                                                                                                                                                                                                                                                                              Set inform_about_kernel_change.

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • boolean b

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.3.17. SetVgaType

                                                                                                                                                                                                                                                                                                                                                                              Set the vga= kernel argument FIXME is heer because of bootloader module, should be removed

                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                              • string new_vga

                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                              126.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                              126.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                              126.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                              • Arch
                                                                                                                                                                                                                                                                                                                                                                              • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                              • Stage

                                                                                                                                                                                                                                                                                                                                                                              126.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                127. KeyManager

                                                                                                                                                                                                                                                                                                                                                                                Manages GPG keys in the package manager

                                                                                                                                                                                                                                                                                                                                                                                127.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                • Ladislav SlezĂĄk <lslezak@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                127.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                • DeleteKey - Delete the key from the package manager

                                                                                                                                                                                                                                                                                                                                                                                • GetKeys - Return the current keys.

                                                                                                                                                                                                                                                                                                                                                                                • ImportFromFile - Import key from a file

                                                                                                                                                                                                                                                                                                                                                                                • Modified - Has been something changed?

                                                                                                                                                                                                                                                                                                                                                                                • Read - Read the current configuration from the package manager. The previous changes are lost (@see Reset). The target system of the package manager must be initialized before reading GPG keys!

                                                                                                                                                                                                                                                                                                                                                                                • Reset - Reset the internal state of the module. The current configuration and all changes are deleted.

                                                                                                                                                                                                                                                                                                                                                                                • SearchGPGKey - Search a GPG key in the known keys

                                                                                                                                                                                                                                                                                                                                                                                • Write - Apply the changes, update the current status

                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                  127.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                  127.3.1. DeleteKey

                                                                                                                                                                                                                                                                                                                                                                                  Delete the key from the package manager

                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                  • string key_id

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                  127.3.2. GetKeys

                                                                                                                                                                                                                                                                                                                                                                                  Return the current keys.

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • list<map<string,any> > - list of known GPG keys ($[ "id" : string, "name" : string, "trusted" : boolean ])

                                                                                                                                                                                                                                                                                                                                                                                  127.3.3. ImportFromFile

                                                                                                                                                                                                                                                                                                                                                                                  Import key from a file

                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                                                                                                                                  • boolean trusted

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> - map with the key, nil when import fails (invalid key, not existing file, already imported key...)

                                                                                                                                                                                                                                                                                                                                                                                  127.3.4. Modified

                                                                                                                                                                                                                                                                                                                                                                                  Has been something changed?

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if something has been changed

                                                                                                                                                                                                                                                                                                                                                                                  127.3.5. Read

                                                                                                                                                                                                                                                                                                                                                                                  Read the current configuration from the package manager. The previous changes are lost (@see Reset). The target system of the package manager must be initialized before reading GPG keys!

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                  127.3.6. Reset

                                                                                                                                                                                                                                                                                                                                                                                  Reset the internal state of the module. The current configuration and all changes are deleted.

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                  127.3.7. SearchGPGKey

                                                                                                                                                                                                                                                                                                                                                                                  Search a GPG key in the known keys

                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                  • string key_id

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> - Data about the key or nil if the key was not found

                                                                                                                                                                                                                                                                                                                                                                                  127.3.8. Write

                                                                                                                                                                                                                                                                                                                                                                                  Apply the changes, update the current status

                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                  127.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                  127.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                  127.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                                  • String

                                                                                                                                                                                                                                                                                                                                                                                  127.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                    128. Keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Provide information regarding the keyboard.

                                                                                                                                                                                                                                                                                                                                                                                    128.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                    • Thomas Roelz <tom@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                    • Maintainer: Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                    128.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                    • CalledRestore - CalledRestore()

                                                                                                                                                                                                                                                                                                                                                                                    • CheckKeyboardDuringUpdate - Special function for update mode only. Checks for the keyboard layout on the system which should be updated and if it differs from current one, opens a popup with the offer to change the layout. See discussion in bug #71069

                                                                                                                                                                                                                                                                                                                                                                                    • Export - AutoYaST interface function: Return the Keyboard configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                    • GetExpertValues - GetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                    • GetKeyboardForLanguage - GetKeyboardForLanguage()

                                                                                                                                                                                                                                                                                                                                                                                    • GetKeyboardItems - Return item list of keyboard items, sorted according to current language

                                                                                                                                                                                                                                                                                                                                                                                    • GetX11KeyData - GetX11KeyData()

                                                                                                                                                                                                                                                                                                                                                                                    • Import - AutoYaST interface function: Get the Keyboard configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                    • Keyboard - Keyboard()

                                                                                                                                                                                                                                                                                                                                                                                    • MakeProposal - MakeProposal()

                                                                                                                                                                                                                                                                                                                                                                                    • Modified - was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                    • Name - Name() Just return the keyboard name, without setting anything.

                                                                                                                                                                                                                                                                                                                                                                                    • Probe - Probe()

                                                                                                                                                                                                                                                                                                                                                                                    • Read - Just store inital values - read was done in constructor

                                                                                                                                                                                                                                                                                                                                                                                    • Restore - Restore the the data from sysconfig.

                                                                                                                                                                                                                                                                                                                                                                                    • Save - Save the current data into a file to be read after a reboot.

                                                                                                                                                                                                                                                                                                                                                                                    • Selection - Selection()

                                                                                                                                                                                                                                                                                                                                                                                    • Set - Set()

                                                                                                                                                                                                                                                                                                                                                                                    • SetConsole - Set the console keyboard to the given keyboard language.

                                                                                                                                                                                                                                                                                                                                                                                    • SetExpertValues - SetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                    • SetKeyboard - SetKeyboard()

                                                                                                                                                                                                                                                                                                                                                                                    • SetX11 - Set the X11 keyboard to the given keyboard language.

                                                                                                                                                                                                                                                                                                                                                                                    • Summary - AutoYaST interface function: Return the summary of Keyboard configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                    • get_lang2keyboard - Get the system_language --> keyboard_language conversion map.

                                                                                                                                                                                                                                                                                                                                                                                    • keymap2yast - Return a map for conversion from keymap to YaST2 keyboard code() Get the map of translated keyboard names.

                                                                                                                                                                                                                                                                                                                                                                                    • xf86_update - Updates the X11 keyboard settings (using SaX library)

                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                    128.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                    128.3.1. CalledRestore

                                                                                                                                                                                                                                                                                                                                                                                    CalledRestore()

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                    128.3.2. CheckKeyboardDuringUpdate

                                                                                                                                                                                                                                                                                                                                                                                    Special function for update mode only. Checks for the keyboard layout on the system which should be updated and if it differs from current one, opens a popup with the offer to change the layout. See discussion in bug #71069

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string destdir

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                    128.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                    AutoYaST interface function: Return the Keyboard configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map - with the settings

                                                                                                                                                                                                                                                                                                                                                                                    128.3.4. GetExpertValues

                                                                                                                                                                                                                                                                                                                                                                                    GetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map - with values filled in

                                                                                                                                                                                                                                                                                                                                                                                    128.3.5. GetKeyboardForLanguage

                                                                                                                                                                                                                                                                                                                                                                                    GetKeyboardForLanguage()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string sys_language

                                                                                                                                                                                                                                                                                                                                                                                    • string default_keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - The keyboard language for this language, e.g. "english-us" or the default value if nothing found.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.6. GetKeyboardItems

                                                                                                                                                                                                                                                                                                                                                                                    Return item list of keyboard items, sorted according to current language

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • list<term>

                                                                                                                                                                                                                                                                                                                                                                                    128.3.7. GetX11KeyData

                                                                                                                                                                                                                                                                                                                                                                                    GetX11KeyData()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string keymap

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map - containing the x11 config data

                                                                                                                                                                                                                                                                                                                                                                                    128.3.8. Import

                                                                                                                                                                                                                                                                                                                                                                                    AutoYaST interface function: Get the Keyboard configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                    128.3.9. Keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Keyboard()

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                    • Probe()

                                                                                                                                                                                                                                                                                                                                                                                    128.3.10. MakeProposal

                                                                                                                                                                                                                                                                                                                                                                                    MakeProposal()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • boolean force_reset

                                                                                                                                                                                                                                                                                                                                                                                    • boolean language_changed

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - user readable description. If force_reset is true reset the module to the keyboard stored in default_kbd.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.11. Modified

                                                                                                                                                                                                                                                                                                                                                                                    was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                    128.3.12. Name

                                                                                                                                                                                                                                                                                                                                                                                    Name() Just return the keyboard name, without setting anything.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - user readable description.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.13. Probe

                                                                                                                                                                                                                                                                                                                                                                                    Probe()

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                    • Keyboard()

                                                                                                                                                                                                                                                                                                                                                                                    128.3.14. Read

                                                                                                                                                                                                                                                                                                                                                                                    Just store inital values - read was done in constructor

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                    128.3.15. Restore

                                                                                                                                                                                                                                                                                                                                                                                    Restore the the data from sysconfig.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true - Data could be restored false - Restore not successful

                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                    • Save()

                                                                                                                                                                                                                                                                                                                                                                                    128.3.16. Save

                                                                                                                                                                                                                                                                                                                                                                                    Save the current data into a file to be read after a reboot.

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • boolean update_x11

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                    128.3.17. Selection

                                                                                                                                                                                                                                                                                                                                                                                    Selection()

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map<string, string> - of $[ keyboard_code : keyboard_name, ...] for all known keyboards. 'keyboard_code' is used internally in Set and Get functions. 'keyboard_name' is a user-readable string.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.18. Set

                                                                                                                                                                                                                                                                                                                                                                                    Set()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void -

                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                    • SetX11(), SetConsole()

                                                                                                                                                                                                                                                                                                                                                                                    128.3.19. SetConsole

                                                                                                                                                                                                                                                                                                                                                                                    Set the console keyboard to the given keyboard language.

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - The loadkeys command that has been executed to do it. (also stored in Keyboard::ckb_cmd)

                                                                                                                                                                                                                                                                                                                                                                                    128.3.20. SetExpertValues

                                                                                                                                                                                                                                                                                                                                                                                    SetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • map val

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                    128.3.21. SetKeyboard

                                                                                                                                                                                                                                                                                                                                                                                    SetKeyboard()

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true - Success. Language set in public data. false - Error. Language not set.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.22. SetX11

                                                                                                                                                                                                                                                                                                                                                                                    Set the X11 keyboard to the given keyboard language.

                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                    • string keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - The xkbset command that has been executed to do it. (also stored in Keyboard::xkb_cmd)

                                                                                                                                                                                                                                                                                                                                                                                    128.3.23. Summary

                                                                                                                                                                                                                                                                                                                                                                                    AutoYaST interface function: Return the summary of Keyboard configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • string - summary string (html)

                                                                                                                                                                                                                                                                                                                                                                                    128.3.24. get_lang2keyboard

                                                                                                                                                                                                                                                                                                                                                                                    Get the system_language --> keyboard_language conversion map.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map - conversion map

                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                    • get_xkblayout2keyboard()

                                                                                                                                                                                                                                                                                                                                                                                    128.3.25. keymap2yast

                                                                                                                                                                                                                                                                                                                                                                                    Return a map for conversion from keymap to YaST2 keyboard code() Get the map of translated keyboard names.

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • map<string, string> - of $[ keyboard_code : keyboard_name, ...] for all known keyboards. 'keyboard_code' is used internally in Set and Get functions. 'keyboard_name' is a user-readable string. Uses Language::language for translation.

                                                                                                                                                                                                                                                                                                                                                                                    128.3.26. xf86_update

                                                                                                                                                                                                                                                                                                                                                                                    Updates the X11 keyboard settings (using SaX library)

                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                    • boolean - - success

                                                                                                                                                                                                                                                                                                                                                                                    128.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                    128.4.1. expert_on_entry

                                                                                                                                                                                                                                                                                                                                                                                    expert values on start

                                                                                                                                                                                                                                                                                                                                                                                    128.4.2. keyboard_on_entry

                                                                                                                                                                                                                                                                                                                                                                                    keyboard set on start

                                                                                                                                                                                                                                                                                                                                                                                    128.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                    128.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                    • Arch
                                                                                                                                                                                                                                                                                                                                                                                    • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                    • HTML
                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                    • Language
                                                                                                                                                                                                                                                                                                                                                                                    • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                    • Misc
                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                    • Package
                                                                                                                                                                                                                                                                                                                                                                                    • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                    • Stage
                                                                                                                                                                                                                                                                                                                                                                                    • XLibAPI
                                                                                                                                                                                                                                                                                                                                                                                    • XVersion

                                                                                                                                                                                                                                                                                                                                                                                    128.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                      129. Kickstart

                                                                                                                                                                                                                                                                                                                                                                                      Imports older and foreign formats

                                                                                                                                                                                                                                                                                                                                                                                      129.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                      • Anas Nashif<nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                      129.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                        129.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                        129.3.1. KS2AY

                                                                                                                                                                                                                                                                                                                                                                                        Kickstart to AutoYaST main

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any>

                                                                                                                                                                                                                                                                                                                                                                                        129.3.2. Kickstart

                                                                                                                                                                                                                                                                                                                                                                                        Constructor

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                        129.3.3. Read

                                                                                                                                                                                                                                                                                                                                                                                        Read a Kickstart file

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • map - kickstart configuration.

                                                                                                                                                                                                                                                                                                                                                                                        129.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                        129.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                        129.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                        • AutoinstConfig
                                                                                                                                                                                                                                                                                                                                                                                        • AutoinstStorage
                                                                                                                                                                                                                                                                                                                                                                                        • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                        • IP
                                                                                                                                                                                                                                                                                                                                                                                        • Keyboard
                                                                                                                                                                                                                                                                                                                                                                                        • Partitions
                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                        • Profile
                                                                                                                                                                                                                                                                                                                                                                                        • Y2ModuleConfig

                                                                                                                                                                                                                                                                                                                                                                                        129.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                        • autoinstall/xml.ycp

                                                                                                                                                                                                                                                                                                                                                                                        130. Kiwi

                                                                                                                                                                                                                                                                                                                                                                                        Data for kiwi configuration, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                        130.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                        • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                        130.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                        • content_key - argument for any_xml agent: key indicating content of element without attributes

                                                                                                                                                                                                                                                                                                                                                                                        130.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                        130.3.1. ImportImageRepositories

                                                                                                                                                                                                                                                                                                                                                                                        Import repositories from given kiwi image configuration

                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                        • map Config

                                                                                                                                                                                                                                                                                                                                                                                        • string dir

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • map <string,map>

                                                                                                                                                                                                                                                                                                                                                                                        130.3.2. InitCurrentRepositories

                                                                                                                                                                                                                                                                                                                                                                                        Initialize the list of current repositories

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • map <string,map>

                                                                                                                                                                                                                                                                                                                                                                                        130.3.3. PrepareAndCreate

                                                                                                                                                                                                                                                                                                                                                                                        run kiwi to finally create the selected image

                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                        • string out_dir

                                                                                                                                                                                                                                                                                                                                                                                        • string selected_profiles

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                        130.3.4. Read

                                                                                                                                                                                                                                                                                                                                                                                        REad the confgiuration stuff for image creator

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                        130.3.5. ReadConfigXML

                                                                                                                                                                                                                                                                                                                                                                                        import the data from given config.xml

                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                        • string base_path

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any>

                                                                                                                                                                                                                                                                                                                                                                                        130.3.6. ReadImageTemplates

                                                                                                                                                                                                                                                                                                                                                                                        Read the templates on which the images can be based

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                        130.3.7. SaveConfiguration

                                                                                                                                                                                                                                                                                                                                                                                        save the image configuration to the kiwi images directory

                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                        • map KiwiConfig

                                                                                                                                                                                                                                                                                                                                                                                        • string task

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                        130.3.8. WriteConfigXML

                                                                                                                                                                                                                                                                                                                                                                                        Write currect configuration to new config.xml

                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any> KiwiConfig

                                                                                                                                                                                                                                                                                                                                                                                        • string task

                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                        130.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                        130.4.1. content_key

                                                                                                                                                                                                                                                                                                                                                                                        argument for any_xml agent: key indicating content of element without attributes

                                                                                                                                                                                                                                                                                                                                                                                        130.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                        130.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                        • Directory
                                                                                                                                                                                                                                                                                                                                                                                        • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                        • Message
                                                                                                                                                                                                                                                                                                                                                                                        • Package
                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                        • Security
                                                                                                                                                                                                                                                                                                                                                                                        • String
                                                                                                                                                                                                                                                                                                                                                                                        • URL

                                                                                                                                                                                                                                                                                                                                                                                        130.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                        • product-creator/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                        131. Label

                                                                                                                                                                                                                                                                                                                                                                                        Often used messages and button labels

                                                                                                                                                                                                                                                                                                                                                                                        131.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                        • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                        • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                        • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                        131.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                          131.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                          131.3.1. AbortButton

                                                                                                                                                                                                                                                                                                                                                                                          Abort Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.2. AbortInstallationButton

                                                                                                                                                                                                                                                                                                                                                                                          Abort Installation Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.3. AcceptButton

                                                                                                                                                                                                                                                                                                                                                                                          Accept Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.4. AddButton

                                                                                                                                                                                                                                                                                                                                                                                          Add Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.5. BackButton

                                                                                                                                                                                                                                                                                                                                                                                          Back Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.6. BrowseButton

                                                                                                                                                                                                                                                                                                                                                                                          Browse Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.7. CancelButton

                                                                                                                                                                                                                                                                                                                                                                                          Cancel Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.8. CloseButton

                                                                                                                                                                                                                                                                                                                                                                                          Close Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.9. ConfirmPassword

                                                                                                                                                                                                                                                                                                                                                                                          Confirm Password TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.10. ContinueButton

                                                                                                                                                                                                                                                                                                                                                                                          Continue Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.11. CreateButton

                                                                                                                                                                                                                                                                                                                                                                                          Create Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.12. DefaultFunctionKeyMap

                                                                                                                                                                                                                                                                                                                                                                                          Default function key map

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • map<string, integer>

                                                                                                                                                                                                                                                                                                                                                                                          131.3.13. DeleteButton

                                                                                                                                                                                                                                                                                                                                                                                          Delete Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.14. DoNotAcceptButton

                                                                                                                                                                                                                                                                                                                                                                                          Do Not Accept Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.15. DontInstallButton

                                                                                                                                                                                                                                                                                                                                                                                          Don't Install Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.16. DownButton

                                                                                                                                                                                                                                                                                                                                                                                          Down Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.17. DownloadButton

                                                                                                                                                                                                                                                                                                                                                                                          Download Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.18. EditButton

                                                                                                                                                                                                                                                                                                                                                                                          Edit Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.19. ErrorMsg

                                                                                                                                                                                                                                                                                                                                                                                          Error Message

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.20. FileName

                                                                                                                                                                                                                                                                                                                                                                                          File Name TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.21. FinishButton

                                                                                                                                                                                                                                                                                                                                                                                          Finish Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.22. HelpButton

                                                                                                                                                                                                                                                                                                                                                                                          Help Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.23. HostName

                                                                                                                                                                                                                                                                                                                                                                                          Host Name TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.24. IgnoreButton

                                                                                                                                                                                                                                                                                                                                                                                          Ignore Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.25. InstallButton

                                                                                                                                                                                                                                                                                                                                                                                          Install Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.26. NewButton

                                                                                                                                                                                                                                                                                                                                                                                          New Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.27. NextButton

                                                                                                                                                                                                                                                                                                                                                                                          Next Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.28. NoButton

                                                                                                                                                                                                                                                                                                                                                                                          No Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.29. OKButton

                                                                                                                                                                                                                                                                                                                                                                                          OK Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.30. Options

                                                                                                                                                                                                                                                                                                                                                                                          Options TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.31. Password

                                                                                                                                                                                                                                                                                                                                                                                          Password TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.32. PleaseWaitMsg

                                                                                                                                                                                                                                                                                                                                                                                          Please wait Message

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.33. Port

                                                                                                                                                                                                                                                                                                                                                                                          Port TextEntry

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.34. QuitButton

                                                                                                                                                                                                                                                                                                                                                                                          Quit Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.35. RefreshButton

                                                                                                                                                                                                                                                                                                                                                                                          Refresh Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.36. RemoveButton

                                                                                                                                                                                                                                                                                                                                                                                          Remove Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.37. ReplaceButton

                                                                                                                                                                                                                                                                                                                                                                                          Replace Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.38. RetryButton

                                                                                                                                                                                                                                                                                                                                                                                          Retry Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.39. SaveButton

                                                                                                                                                                                                                                                                                                                                                                                          Save Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.40. SelectButton

                                                                                                                                                                                                                                                                                                                                                                                          Select Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.41. SkipButton

                                                                                                                                                                                                                                                                                                                                                                                          Skip Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.42. StopButton

                                                                                                                                                                                                                                                                                                                                                                                          Stop Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.43. UpButton

                                                                                                                                                                                                                                                                                                                                                                                          Up Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.44. WarningMsg

                                                                                                                                                                                                                                                                                                                                                                                          Warning Message

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.3.45. YesButton

                                                                                                                                                                                                                                                                                                                                                                                          Yes Button

                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                          131.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                          131.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                                                                                                                                          132. Lan

                                                                                                                                                                                                                                                                                                                                                                                          Network card data

                                                                                                                                                                                                                                                                                                                                                                                          132.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                          • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                          132.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                            132.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                            132.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                            Add a new device

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.2. AnyDHCPDevice

                                                                                                                                                                                                                                                                                                                                                                                            Check if any device is configured with DHCP.

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if any DHCP device is configured

                                                                                                                                                                                                                                                                                                                                                                                            132.3.3. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                            Return value

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

                                                                                                                                                                                                                                                                                                                                                                                            132.3.4. Autoinstall

                                                                                                                                                                                                                                                                                                                                                                                            Create a configuration for autoyast

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if something was proposed

                                                                                                                                                                                                                                                                                                                                                                                            132.3.5. Delete

                                                                                                                                                                                                                                                                                                                                                                                            Delete the given device

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.6. Edit

                                                                                                                                                                                                                                                                                                                                                                                            Edit the given device

                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.7. Export

                                                                                                                                                                                                                                                                                                                                                                                            Export data

                                                                                                                                                                                                                                                                                                                                                                                            Return value

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

                                                                                                                                                                                                                                                                                                                                                                                            132.3.8. HaveXenBridge

                                                                                                                                                                                                                                                                                                                                                                                            Xen bridging confuses us (#178848)

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - whether xenbr* exists

                                                                                                                                                                                                                                                                                                                                                                                            132.3.9. Import

                                                                                                                                                                                                                                                                                                                                                                                            Import data

                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.10. Packages

                                                                                                                                                                                                                                                                                                                                                                                            Return value

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

                                                                                                                                                                                                                                                                                                                                                                                            132.3.11. Propose

                                                                                                                                                                                                                                                                                                                                                                                            Propose a configuration

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if something was proposed

                                                                                                                                                                                                                                                                                                                                                                                            132.3.12. ProposeInterfaces

                                                                                                                                                                                                                                                                                                                                                                                            Propose interface configuration

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if something was proposed

                                                                                                                                                                                                                                                                                                                                                                                            132.3.13. ProposeRoutesAndResolver

                                                                                                                                                                                                                                                                                                                                                                                            Propose configuration for routing and resolver

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if something was proposed

                                                                                                                                                                                                                                                                                                                                                                                            132.3.14. Read

                                                                                                                                                                                                                                                                                                                                                                                            Read all network settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                            • symbol cache

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.15. ReadWithCache

                                                                                                                                                                                                                                                                                                                                                                                            (a specialization used when a parameterless function is needed)

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Read(`cache)

                                                                                                                                                                                                                                                                                                                                                                                            132.3.16. Summary

                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary and a list of unconfigured devices

                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                            132.3.17. SummaryGeneral

                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary for the general network settings proposal (NetworkManager + ipv6)

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • list - [rich text, links]

                                                                                                                                                                                                                                                                                                                                                                                            132.3.18. Write

                                                                                                                                                                                                                                                                                                                                                                                            Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                            132.3.19. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                            Only write configuration without starting any init scripts and SuSEconfig

                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                            132.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                            132.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                            132.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                            • Arch
                                                                                                                                                                                                                                                                                                                                                                                            • DNS
                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                            • Host
                                                                                                                                                                                                                                                                                                                                                                                            • Hostname
                                                                                                                                                                                                                                                                                                                                                                                            • IP
                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                            • LanItems
                                                                                                                                                                                                                                                                                                                                                                                            • LanUdevAuto
                                                                                                                                                                                                                                                                                                                                                                                            • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                            • Map
                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                            • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                            • NetHwDetection
                                                                                                                                                                                                                                                                                                                                                                                            • NetworkConfig
                                                                                                                                                                                                                                                                                                                                                                                            • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                            • NetworkService
                                                                                                                                                                                                                                                                                                                                                                                            • NetworkStorage
                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                            • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                            • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                            • Routing
                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                            • Stage
                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                            • SuSEFirewall4Network
                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                            132.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                            • network/complex.ycp
                                                                                                                                                                                                                                                                                                                                                                                            • network/runtime.ycp

                                                                                                                                                                                                                                                                                                                                                                                            133. LanItems

                                                                                                                                                                                                                                                                                                                                                                                            133.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                              133.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                              • Items - Hardware information

                                                                                                                                                                                                                                                                                                                                                                                              • SysconfigDefaults - the defaults here are what sysconfig defaults to (as opposed to what a new interface gets, in @ref Select)

                                                                                                                                                                                                                                                                                                                                                                                              • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                              • operation - Which operation is pending?

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

                                                                                                                                                                                                                                                                                                                                                                                              133.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                              133.3.1. Commit

                                                                                                                                                                                                                                                                                                                                                                                              Commit pending operation

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                              133.3.2. FindMatchingDevice

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

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • map interface

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • map - The map of the matching device.

                                                                                                                                                                                                                                                                                                                                                                                              133.3.3. FreeAliases

                                                                                                                                                                                                                                                                                                                                                                                              Return 10 free aliases

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • string type

                                                                                                                                                                                                                                                                                                                                                                                              • integer num

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • list - of 10 free devices

                                                                                                                                                                                                                                                                                                                                                                                              133.3.4. FreeDevices

                                                                                                                                                                                                                                                                                                                                                                                              Return 10 free devices

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • string type

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • list - of 10 free devices

                                                                                                                                                                                                                                                                                                                                                                                              133.3.5. GetDefaultsForHW

                                                                                                                                                                                                                                                                                                                                                                                              must be in sync with @ref SetDefaultsForHW

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • map

                                                                                                                                                                                                                                                                                                                                                                                              133.3.6. GetModified

                                                                                                                                                                                                                                                                                                                                                                                              Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                              133.3.7. GetModuleForInterface

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

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • string ay_device

                                                                                                                                                                                                                                                                                                                                                                                              • list<map> ay_modules

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • map - the module map with module name and options

                                                                                                                                                                                                                                                                                                                                                                                              133.3.8. InterfaceHasAliases

                                                                                                                                                                                                                                                                                                                                                                                              Check if the given device has any virtual alias.

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if there are some aliases

                                                                                                                                                                                                                                                                                                                                                                                              133.3.9. Modified

                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                              133.3.10. Overview

                                                                                                                                                                                                                                                                                                                                                                                              Create an overview table with all configured devices

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • list - table items

                                                                                                                                                                                                                                                                                                                                                                                              133.3.11. Select

                                                                                                                                                                                                                                                                                                                                                                                              Select the given device

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • string dev

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                              133.3.12. SelectHW

                                                                                                                                                                                                                                                                                                                                                                                              Select the hardware component

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • integer which

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.3.13. SelectHWMap

                                                                                                                                                                                                                                                                                                                                                                                              Select the hardware component

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • map hardware

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.3.14. SetDefaultsForHW

                                                                                                                                                                                                                                                                                                                                                                                              must be in sync with @ref GetDefaultsForHW

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.3.15. SetDeviceVars

                                                                                                                                                                                                                                                                                                                                                                                              Set various device variables

                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                              • map devmap

                                                                                                                                                                                                                                                                                                                                                                                              • map defaults

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.3.16. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.3.17. UnsetModified

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

                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                              133.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                              133.4.1. Items

                                                                                                                                                                                                                                                                                                                                                                                              Hardware information

                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                              • ReadHardware

                                                                                                                                                                                                                                                                                                                                                                                              133.4.2. SysconfigDefaults

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

                                                                                                                                                                                                                                                                                                                                                                                              133.4.3. modified

                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                              133.4.4. operation

                                                                                                                                                                                                                                                                                                                                                                                              Which operation is pending?

                                                                                                                                                                                                                                                                                                                                                                                              133.4.5. 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")

                                                                                                                                                                                                                                                                                                                                                                                              133.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                              133.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                              • NetworkConfig
                                                                                                                                                                                                                                                                                                                                                                                              • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                              • NetworkStorage
                                                                                                                                                                                                                                                                                                                                                                                              • ProductFeatures

                                                                                                                                                                                                                                                                                                                                                                                              133.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                              • network/complex.ycp
                                                                                                                                                                                                                                                                                                                                                                                              • network/hardware.ycp
                                                                                                                                                                                                                                                                                                                                                                                              • network/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                              134. LanUdevAuto

                                                                                                                                                                                                                                                                                                                                                                                              Udev rules for autoinstallation

                                                                                                                                                                                                                                                                                                                                                                                              134.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                              • Michal Zugec <mzugec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                              134.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                  134.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                  134.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                  134.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                  134.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                  • LanItems

                                                                                                                                                                                                                                                                                                                                                                                                  134.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                  • network/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                  135. Language

                                                                                                                                                                                                                                                                                                                                                                                                  This module does all language related stuff:

                                                                                                                                                                                                                                                                                                                                                                                                  135.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                  • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                  • Thomas Roelz <tom@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                  • Maintainer: Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                  135.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                  • CJKLanguage - Check if the language is "CJK" (and thus could not be shown in text mode - see bug #102958)

                                                                                                                                                                                                                                                                                                                                                                                                  • CheckIncompleteTranslation - Checks if translation is complete and displays Continue/Cancel popup messsage if it is not return true if translation is OK or user agrees with the warning

                                                                                                                                                                                                                                                                                                                                                                                                  • CheckLanguagesSupport - check if selected language has support on media (F301238) show a warning when not

                                                                                                                                                                                                                                                                                                                                                                                                  • Export - AutoYaST interface function: Return the Language configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                  • GetExpertValues - GetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLang2KeyboardMap - return the content of lang2keyboard map (mapping of languages to their default (proposed) keyboard layouts)

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLang2TimezoneMap - return the content of lang2timezone map (mapping of languages to their default (proposed) time zones)

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLanguageCountry - de_DE@UTF-8 -> "DE"

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLanguagesMap - Return the whole map with language descriptions

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLocaleString - generate the whole locale string for given language according to DB (e.g. de_DE -> de_DE.UTF-8)

                                                                                                                                                                                                                                                                                                                                                                                                  • GetLocales - return the map of all supported countries and language codes

                                                                                                                                                                                                                                                                                                                                                                                                  • GetName - return user readable description of language

                                                                                                                                                                                                                                                                                                                                                                                                  • GetTextMode - return the value of text_mode (true for ncurses)

                                                                                                                                                                                                                                                                                                                                                                                                  • Import - AutoYaST interface function: Get the Language configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                  • IncompleteTranslation - Returns true if translation for given language is not complete

                                                                                                                                                                                                                                                                                                                                                                                                  • Language - Constructor

                                                                                                                                                                                                                                                                                                                                                                                                  • MakeProposal - Return proposal string.

                                                                                                                                                                                                                                                                                                                                                                                                  • MakeSimpleProposal - Return 'simple' proposal string.

                                                                                                                                                                                                                                                                                                                                                                                                  • Modified - was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                                  • PackagesInit - Initializes source and target, computes the packages necessary to install and uninstall, checks for disk space (#50745)

                                                                                                                                                                                                                                                                                                                                                                                                  • PackagesModified - Does the modification of language(s) require installation of new packages? This test compares the list of original languages (primary+secondary) with the list after user's modifications

                                                                                                                                                                                                                                                                                                                                                                                                  • QuickSet - Set the language that was read from sysconfig, read only one needed language file

                                                                                                                                                                                                                                                                                                                                                                                                  • Read - Store the inital values; in normal mode, read from system was done in constructor

                                                                                                                                                                                                                                                                                                                                                                                                  • ReadSysconfigLanguage - Read the RC_LANG value from sysconfig and exctract language from it

                                                                                                                                                                                                                                                                                                                                                                                                  • ReadSysconfigValues - Read the rest of language values from sysconfig

                                                                                                                                                                                                                                                                                                                                                                                                  • Save - Save state to target.

                                                                                                                                                                                                                                                                                                                                                                                                  • Selection - Return a map of ids and names to build up a selection list for the user. The key is used later in the Set function to select this language. The name is a translated string.

                                                                                                                                                                                                                                                                                                                                                                                                  • Set - Set module to selected language.

                                                                                                                                                                                                                                                                                                                                                                                                  • SetDefault - Store current language as default language.

                                                                                                                                                                                                                                                                                                                                                                                                  • SetExpertValues - SetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                                  • Summary - AutoYaST interface function: Return the summary of Language configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                  • WfmSetGivenLanguage - WfmSetLanguag()

                                                                                                                                                                                                                                                                                                                                                                                                  • WfmSetLanguage - WfmSetLanguag()

                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                  135.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.1. CJKLanguage

                                                                                                                                                                                                                                                                                                                                                                                                  Check if the language is "CJK" (and thus could not be shown in text mode - see bug #102958)

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.2. CheckIncompleteTranslation

                                                                                                                                                                                                                                                                                                                                                                                                  Checks if translation is complete and displays Continue/Cancel popup messsage if it is not return true if translation is OK or user agrees with the warning

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.3. CheckLanguagesSupport

                                                                                                                                                                                                                                                                                                                                                                                                  check if selected language has support on media (F301238) show a warning when not

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string selected_language

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.4. Export

                                                                                                                                                                                                                                                                                                                                                                                                  AutoYaST interface function: Return the Language configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map - with the settings

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.5. GetExpertValues

                                                                                                                                                                                                                                                                                                                                                                                                  GetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map - with values filled in

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.6. GetLang2KeyboardMap

                                                                                                                                                                                                                                                                                                                                                                                                  return the content of lang2keyboard map (mapping of languages to their default (proposed) keyboard layouts)

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,string>

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.7. GetLang2TimezoneMap

                                                                                                                                                                                                                                                                                                                                                                                                  return the content of lang2timezone map (mapping of languages to their default (proposed) time zones)

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,string>

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.8. GetLanguageCountry

                                                                                                                                                                                                                                                                                                                                                                                                  de_DE@UTF-8 -> "DE"

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string - country part of language

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.9. GetLanguagesMap

                                                                                                                                                                                                                                                                                                                                                                                                  Return the whole map with language descriptions

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, list>

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.10. GetLocaleString

                                                                                                                                                                                                                                                                                                                                                                                                  generate the whole locale string for given language according to DB (e.g. de_DE -> de_DE.UTF-8)

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.11. GetLocales

                                                                                                                                                                                                                                                                                                                                                                                                  return the map of all supported countries and language codes

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,integer>

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.12. GetName

                                                                                                                                                                                                                                                                                                                                                                                                  return user readable description of language

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.13. GetTextMode

                                                                                                                                                                                                                                                                                                                                                                                                  return the value of text_mode (true for ncurses)

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.14. Import

                                                                                                                                                                                                                                                                                                                                                                                                  AutoYaST interface function: Get the Language configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • map settings

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.15. IncompleteTranslation

                                                                                                                                                                                                                                                                                                                                                                                                  Returns true if translation for given language is not complete

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.16. Language

                                                                                                                                                                                                                                                                                                                                                                                                  Constructor

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.17. MakeProposal

                                                                                                                                                                                                                                                                                                                                                                                                  Return proposal string.

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean force_reset

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean language_changed

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - user readable description. If force_reset is true reset the module to the language stored in default_language.

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.18. MakeSimpleProposal

                                                                                                                                                                                                                                                                                                                                                                                                  Return 'simple' proposal string.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string - preformated description.

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.19. Modified

                                                                                                                                                                                                                                                                                                                                                                                                  was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.20. PackagesInit

                                                                                                                                                                                                                                                                                                                                                                                                  Initializes source and target, computes the packages necessary to install and uninstall, checks for disk space (#50745)

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> selected_languages

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - false when there is not enough disk space for new packages

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.21. PackagesModified

                                                                                                                                                                                                                                                                                                                                                                                                  Does the modification of language(s) require installation of new packages? This test compares the list of original languages (primary+secondary) with the list after user's modifications

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.22. QuickSet

                                                                                                                                                                                                                                                                                                                                                                                                  Set the language that was read from sysconfig, read only one needed language file

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.23. Read

                                                                                                                                                                                                                                                                                                                                                                                                  Store the inital values; in normal mode, read from system was done in constructor

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean really

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.24. ReadSysconfigLanguage

                                                                                                                                                                                                                                                                                                                                                                                                  Read the RC_LANG value from sysconfig and exctract language from it

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string - language

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.25. ReadSysconfigValues

                                                                                                                                                                                                                                                                                                                                                                                                  Read the rest of language values from sysconfig

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.26. Save

                                                                                                                                                                                                                                                                                                                                                                                                  Save state to target.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.27. Selection

                                                                                                                                                                                                                                                                                                                                                                                                  Return a map of ids and names to build up a selection list for the user. The key is used later in the Set function to select this language. The name is a translated string.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, list> - of $[ language : [ utf8-name, ascii-name] ...] for all known languages 'language' is the (2 or 5 char) ISO language code. 'utf8-name' is a user-readable (UTF-8 encoded !) string. 'ascii-name' is an english (ascii encoded !) string.

                                                                                                                                                                                                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                                                                                                                                                                                                  • Set

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.28. Set

                                                                                                                                                                                                                                                                                                                                                                                                  Set module to selected language.

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.29. SetDefault

                                                                                                                                                                                                                                                                                                                                                                                                  Store current language as default language.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.30. SetExpertValues

                                                                                                                                                                                                                                                                                                                                                                                                  SetExpertValues()

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • map val

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void -

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.31. Summary

                                                                                                                                                                                                                                                                                                                                                                                                  AutoYaST interface function: Return the summary of Language configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • string - summary string

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.32. WfmSetGivenLanguage

                                                                                                                                                                                                                                                                                                                                                                                                  WfmSetLanguag()

                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • string lang

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void - -

                                                                                                                                                                                                                                                                                                                                                                                                  135.3.33. WfmSetLanguage

                                                                                                                                                                                                                                                                                                                                                                                                  WfmSetLanguag()

                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                  • void - -

                                                                                                                                                                                                                                                                                                                                                                                                  135.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.1. language

                                                                                                                                                                                                                                                                                                                                                                                                  currently selected language

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.2. language_on_entry

                                                                                                                                                                                                                                                                                                                                                                                                  original language

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.3. languages

                                                                                                                                                                                                                                                                                                                                                                                                  Default settings for INSTALLED_LANGUAGES in /etc/sysconfig/language

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.4. languages_on_entry

                                                                                                                                                                                                                                                                                                                                                                                                  Original value of INSTALLED_LANGUAGES

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.5. preselected

                                                                                                                                                                                                                                                                                                                                                                                                  language preselected in /etc/install.inf

                                                                                                                                                                                                                                                                                                                                                                                                  135.4.6. selection_skipped

                                                                                                                                                                                                                                                                                                                                                                                                  Was the initial language selection skipped? (see bug 223258) (It can be, if the language was selected in linuxrc)

                                                                                                                                                                                                                                                                                                                                                                                                  135.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                  135.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                  • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                                                                                                                                                                                                  • Encoding
                                                                                                                                                                                                                                                                                                                                                                                                  • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                  • HTML
                                                                                                                                                                                                                                                                                                                                                                                                  • InstExtensionImage
                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                  • Misc
                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                  • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                  • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                  • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                  • Stage

                                                                                                                                                                                                                                                                                                                                                                                                  135.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                    136. Ldap

                                                                                                                                                                                                                                                                                                                                                                                                    LDAP client configuration data, I/O functions.

                                                                                                                                                                                                                                                                                                                                                                                                    136.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                    • Thorsten Kukuk <kukuk@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                    • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                    136.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                    • AddMissingAttributes - For a given object, add all atributes this object is allowed to have according to its "objectClass" value. Added attributes have empty values.

                                                                                                                                                                                                                                                                                                                                                                                                    • AttributeDescription - Gets the description of attribute (from schema)

                                                                                                                                                                                                                                                                                                                                                                                                    • AutoPackages - Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                    • BaseDNChanged - If the base DN has changed from a nonempty one, it may only be changed at boot time. Use this to warn the user.

                                                                                                                                                                                                                                                                                                                                                                                                    • CheckBaseConfig - Check if base config DN belongs to some existing object and offer creating it if necessary

                                                                                                                                                                                                                                                                                                                                                                                                    • CheckNDS - Check the server if it is NDS (novell directory service)

                                                                                                                                                                                                                                                                                                                                                                                                    • CheckOES - Check if current machine runs OES

                                                                                                                                                                                                                                                                                                                                                                                                    • CheckOrderOfCreation - Check if references to other objects are correct; create these objects if possible

                                                                                                                                                                                                                                                                                                                                                                                                    • CheckTemplateDN - Check if given DN exist and if it points to some template

                                                                                                                                                                                                                                                                                                                                                                                                    • CommitConfigModules - Save the edited map of configuration modules to global map

                                                                                                                                                                                                                                                                                                                                                                                                    • CommitTemplates - Save the edited map of templates to global map

                                                                                                                                                                                                                                                                                                                                                                                                    • ConnectWithoutTLS - popup shown after failed connection: ask for retry withou TLS (see bug 246397)

                                                                                                                                                                                                                                                                                                                                                                                                    • ConvertDefaultValues - In template object, convert the list of values (which is in the form [ "a1=v1", "a2=v2"]) to map (in the form $[ "a1":"v1", "a2":"v2"]

                                                                                                                                                                                                                                                                                                                                                                                                    • CreateModule - Creates default new map for new configuration object

                                                                                                                                                                                                                                                                                                                                                                                                    • CreateTemplate - Creates default new map for a new object template

                                                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the LDAP settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                    • GetAllAttributes - Returns allowed and required attributes of given object class Read it from LDAP if it was not done yet.

                                                                                                                                                                                                                                                                                                                                                                                                    • GetBaseDN - Get the Base DN

                                                                                                                                                                                                                                                                                                                                                                                                    • GetBindDN - return administrator's DN if it was not read yet, read it now

                                                                                                                                                                                                                                                                                                                                                                                                    • GetConfigModules - Return the map of configuration modules (new copy) (in the form $[ DN: $[ map_of_one_module] ])

                                                                                                                                                                                                                                                                                                                                                                                                    • GetDefaultObjectClasses - Return list of default object classes for user or group There is fixed list here, it is not saved anywhere (only in default users plugin for LDAP objects)

                                                                                                                                                                                                                                                                                                                                                                                                    • GetGroupsDN - Returns DN's of groups (objectClass=posixGroup) in given base

                                                                                                                                                                                                                                                                                                                                                                                                    • GetLDAPEntry - Search for one entry (=base scope) in LDAP directory

                                                                                                                                                                                                                                                                                                                                                                                                    • GetLDAPPassword - Asks user for bind password to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    • GetMainConfigDN - Return main configuration object DN

                                                                                                                                                                                                                                                                                                                                                                                                    • GetObjectAttributes - Returns the list of all allowed and required attributes for each object class, given in the list of object classes

                                                                                                                                                                                                                                                                                                                                                                                                    • GetRequiredAttributes - Returns required attributes of given object class Read it from LDAP if it was not done yet.

                                                                                                                                                                                                                                                                                                                                                                                                    • GetTemplates - Return the map of templates (new copy)

                                                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all the LDAP configuration from a map. When called by ldap_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                    • InitSchema - Prepare agent for later schema queries (agent reads schema to its internal structures)

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPAskAndBind - Asks for LDAP password and tries to bind with it

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPBind - Binds to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPError - Reads and returns error message from agent

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPErrorMap - Reads and returns error map (=message + code) from agent

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPErrorMessage - Error popup for errors detected during LDAP operation

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPInit - Initializes LDAP agent

                                                                                                                                                                                                                                                                                                                                                                                                    • LDAPInitWithTLSCheck - Initializes LDAP agent, offers to turn off TLS if it failed

                                                                                                                                                                                                                                                                                                                                                                                                    • ObjectClassExists - Returns true if given object class exists in schema

                                                                                                                                                                                                                                                                                                                                                                                                    • ObjectClassStructural - Returns true if given object class is of 'structural' type

                                                                                                                                                                                                                                                                                                                                                                                                    • ParentExists - Check for existence of parent object of given DN in LDAP tree return the answer

                                                                                                                                                                                                                                                                                                                                                                                                    • Read - Reads LDAP settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                    • ReadConfigModules - Read configuration moduels from LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    • ReadDN - Searches for DN's of all objects defined by filter in given base ("sub")

                                                                                                                                                                                                                                                                                                                                                                                                    • ReadTemplates - Read object templates from LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    • RestartSSHD - Set the value of restart_sshd (= restart sshd during write)

                                                                                                                                                                                                                                                                                                                                                                                                    • Set - Only set variables, without checking anything

                                                                                                                                                                                                                                                                                                                                                                                                    • SetAnonymous - Set the value of 'anonymous' variable (= bind without password)

                                                                                                                                                                                                                                                                                                                                                                                                    • SetBaseDN - Set new LDAP base DN

                                                                                                                                                                                                                                                                                                                                                                                                    • SetBindPassword - Set the value of bind_pass variable

                                                                                                                                                                                                                                                                                                                                                                                                    • SetDefaults - Set the defualt values, which should replace the ones from Read () Used during instalation, when we want to do a reasonable proposal

                                                                                                                                                                                                                                                                                                                                                                                                    • SetGUI - Set the value of 'use_gui' variable (= show error popups)

                                                                                                                                                                                                                                                                                                                                                                                                    • SetReadSettings - set the value of read_settings variable which means, do not read some settings from system

                                                                                                                                                                                                                                                                                                                                                                                                    • ShortSummary - returns html formated configuration summary (shorter than Summary)

                                                                                                                                                                                                                                                                                                                                                                                                    • SingleValued - Check if attribute allowes only single or multiple value

                                                                                                                                                                                                                                                                                                                                                                                                    • Summary - Summary() returns html formated configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                    • UpdatedArchPackages - Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                                                    • Write - Saves LDAP configuration.

                                                                                                                                                                                                                                                                                                                                                                                                    • WriteLDAP - Writes map of objects to LDAP. Ask for password, when needed and shows the error message when necessary.

                                                                                                                                                                                                                                                                                                                                                                                                    • WriteNow - wrapper for Write, without abort block

                                                                                                                                                                                                                                                                                                                                                                                                    • WriteOpenLdapConf - Modify also /etc/openldap/ldap.conf for the use of ldap client utilities (like ldapsearch)

                                                                                                                                                                                                                                                                                                                                                                                                    • WritePlusLine - If a file does not + entry, add it.

                                                                                                                                                                                                                                                                                                                                                                                                    • WriteToLDAP - Writes map of objects to LDAP

                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                    • _autofs_allowed - If no, automounter will not be affected.

                                                                                                                                                                                                                                                                                                                                                                                                    • _start_autofs - Start automounter and import the settings from LDAP

                                                                                                                                                                                                                                                                                                                                                                                                    • attr_types - Map of atribute types (from schema). Indexed by names.

                                                                                                                                                                                                                                                                                                                                                                                                    • available_config_modules - Available configuration modules (objectClass names) TODO update

                                                                                                                                                                                                                                                                                                                                                                                                    • base_config_dn - DN of base configuration object

                                                                                                                                                                                                                                                                                                                                                                                                    • bind_dn - DN for binding to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    • file_server - If home directories of LDAP users are stored on this machine

                                                                                                                                                                                                                                                                                                                                                                                                    • hash_schemas - encryption schemes supported by slappasswd

                                                                                                                                                                                                                                                                                                                                                                                                    • initial_defaults - The defualt values, which should replace the ones from Read () Used during instalation, when we want to do a reasonable proposal

                                                                                                                                                                                                                                                                                                                                                                                                    • initial_defaults_used - If the default values, used from ldap-server module were used to configure ldap-client

                                                                                                                                                                                                                                                                                                                                                                                                    • login_enabled - If login of LDAP uses to local machine is enabled

                                                                                                                                                                                                                                                                                                                                                                                                    • member_attribute - which attribute have LDAP groups for list of members

                                                                                                                                                                                                                                                                                                                                                                                                    • mkhomedir - if pam_mkhomedir is set in /etc/pam.d/commond-session

                                                                                                                                                                                                                                                                                                                                                                                                    • new_objects - defaults for adding new config objects and templates

                                                                                                                                                                                                                                                                                                                                                                                                    • nis_available - Is NIS service available? If yes, and LDAP client will be enabled, warn user (see bug #36981)

                                                                                                                                                                                                                                                                                                                                                                                                    • object_classes - Map of object classes (from schema). Indexed by names.

                                                                                                                                                                                                                                                                                                                                                                                                    • read_settings - If false, do not read settings already set from outside used e.g. for Users YaPI. see bug #60898

                                                                                                                                                                                                                                                                                                                                                                                                    • required_packages - Required packages for this module to operate -- they are now required only when LDAP is set for authentication

                                                                                                                                                                                                                                                                                                                                                                                                    • restart_sshd - if sshd should be restarted during write phase

                                                                                                                                                                                                                                                                                                                                                                                                    • server - IP addresses of LDAP server.

                                                                                                                                                                                                                                                                                                                                                                                                    • start - Are LDAP services available via nsswitch.conf?

                                                                                                                                                                                                                                                                                                                                                                                                    • use_gui - show popups with error messages?

                                                                                                                                                                                                                                                                                                                                                                                                    • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                    136.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.1. AddMissingAttributes

                                                                                                                                                                                                                                                                                                                                                                                                    For a given object, add all atributes this object is allowed to have according to its "objectClass" value. Added attributes have empty values.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map object

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - updated map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.2. AttributeDescription

                                                                                                                                                                                                                                                                                                                                                                                                    Gets the description of attribute (from schema)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string attr

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - description

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.3. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                    Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - of lists.

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.4. BaseDNChanged

                                                                                                                                                                                                                                                                                                                                                                                                    If the base DN has changed from a nonempty one, it may only be changed at boot time. Use this to warn the user.

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether changed by SetBaseDN

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.5. CheckBaseConfig

                                                                                                                                                                                                                                                                                                                                                                                                    Check if base config DN belongs to some existing object and offer creating it if necessary

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string dn

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.6. CheckNDS

                                                                                                                                                                                                                                                                                                                                                                                                    Check the server if it is NDS (novell directory service)

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.7. CheckOES

                                                                                                                                                                                                                                                                                                                                                                                                    Check if current machine runs OES

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.8. CheckOrderOfCreation

                                                                                                                                                                                                                                                                                                                                                                                                    Check if references to other objects are correct; create these objects if possible

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.9. CheckTemplateDN

                                                                                                                                                                                                                                                                                                                                                                                                    Check if given DN exist and if it points to some template

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string dn

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - empty map if DN don't exist, template map if DN points to template object, nil if object with given DN is not template

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.10. CommitConfigModules

                                                                                                                                                                                                                                                                                                                                                                                                    Save the edited map of configuration modules to global map

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map modules

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.11. CommitTemplates

                                                                                                                                                                                                                                                                                                                                                                                                    Save the edited map of templates to global map

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map templs

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.12. ConnectWithoutTLS

                                                                                                                                                                                                                                                                                                                                                                                                    popup shown after failed connection: ask for retry withou TLS (see bug 246397)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map errmap

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if user wants to retry without TLS

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.13. ConvertDefaultValues

                                                                                                                                                                                                                                                                                                                                                                                                    In template object, convert the list of values (which is in the form [ "a1=v1", "a2=v2"]) to map (in the form $[ "a1":"v1", "a2":"v2"]

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map templ

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - updated template map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.14. CreateModule

                                                                                                                                                                                                                                                                                                                                                                                                    Creates default new map for new configuration object

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string cn

                                                                                                                                                                                                                                                                                                                                                                                                    • string class

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map<string,any> - new module map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.15. CreateTemplate

                                                                                                                                                                                                                                                                                                                                                                                                    Creates default new map for a new object template

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string cn

                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> classes

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - template map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.16. Export

                                                                                                                                                                                                                                                                                                                                                                                                    Dump the LDAP settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - $["start":, "servers":[...], "domain":]

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.17. GetAllAttributes

                                                                                                                                                                                                                                                                                                                                                                                                    Returns allowed and required attributes of given object class Read it from LDAP if it was not done yet.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string class

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list - attribute names (list of strings)

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.18. GetBaseDN

                                                                                                                                                                                                                                                                                                                                                                                                    Get the Base DN

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.19. GetBindDN

                                                                                                                                                                                                                                                                                                                                                                                                    return administrator's DN if it was not read yet, read it now

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.20. GetConfigModules

                                                                                                                                                                                                                                                                                                                                                                                                    Return the map of configuration modules (new copy) (in the form $[ DN: $[ map_of_one_module] ])

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.21. GetDefaultObjectClasses

                                                                                                                                                                                                                                                                                                                                                                                                    Return list of default object classes for user or group There is fixed list here, it is not saved anywhere (only in default users plugin for LDAP objects)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map template

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.22. GetGroupsDN

                                                                                                                                                                                                                                                                                                                                                                                                    Returns DN's of groups (objectClass=posixGroup) in given base

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string base

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list - groups (list of strings)

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.23. GetLDAPEntry

                                                                                                                                                                                                                                                                                                                                                                                                    Search for one entry (=base scope) in LDAP directory

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string dn

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - with entry values, empty map if nothing found, nil on error

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.24. GetLDAPPassword

                                                                                                                                                                                                                                                                                                                                                                                                    Asks user for bind password to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean enable_anonymous

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - password

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.25. GetMainConfigDN

                                                                                                                                                                                                                                                                                                                                                                                                    Return main configuration object DN

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.26. GetObjectAttributes

                                                                                                                                                                                                                                                                                                                                                                                                    Returns the list of all allowed and required attributes for each object class, given in the list of object classes

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • list classes

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list - attribute names (list of strings)

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.27. GetRequiredAttributes

                                                                                                                                                                                                                                                                                                                                                                                                    Returns required attributes of given object class Read it from LDAP if it was not done yet.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string class

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> - attribute names (list of strings)

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.28. GetTemplates

                                                                                                                                                                                                                                                                                                                                                                                                    Return the map of templates (new copy)

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.29. Import

                                                                                                                                                                                                                                                                                                                                                                                                    Get all the LDAP configuration from a map. When called by ldap_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.30. InitSchema

                                                                                                                                                                                                                                                                                                                                                                                                    Prepare agent for later schema queries (agent reads schema to its internal structures)

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - error message

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.31. LDAPAskAndBind

                                                                                                                                                                                                                                                                                                                                                                                                    Asks for LDAP password and tries to bind with it

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean enable_anonymous

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - password entered, nil on cancel

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.32. LDAPBind

                                                                                                                                                                                                                                                                                                                                                                                                    Binds to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string pass

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.33. LDAPError

                                                                                                                                                                                                                                                                                                                                                                                                    Reads and returns error message from agent

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.34. LDAPErrorMap

                                                                                                                                                                                                                                                                                                                                                                                                    Reads and returns error map (=message + code) from agent

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.35. LDAPErrorMessage

                                                                                                                                                                                                                                                                                                                                                                                                    Error popup for errors detected during LDAP operation

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string type

                                                                                                                                                                                                                                                                                                                                                                                                    • string error

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.36. LDAPInit

                                                                                                                                                                                                                                                                                                                                                                                                    Initializes LDAP agent

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.37. LDAPInitWithTLSCheck

                                                                                                                                                                                                                                                                                                                                                                                                    Initializes LDAP agent, offers to turn off TLS if it failed

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map args

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.38. ObjectClassExists

                                                                                                                                                                                                                                                                                                                                                                                                    Returns true if given object class exists in schema

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string class

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.39. ObjectClassStructural

                                                                                                                                                                                                                                                                                                                                                                                                    Returns true if given object class is of 'structural' type

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string class

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.40. ParentExists

                                                                                                                                                                                                                                                                                                                                                                                                    Check for existence of parent object of given DN in LDAP tree return the answer

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string dn

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.41. Read

                                                                                                                                                                                                                                                                                                                                                                                                    Reads LDAP settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.42. ReadConfigModules

                                                                                                                                                                                                                                                                                                                                                                                                    Read configuration moduels from LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - error message

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.43. ReadDN

                                                                                                                                                                                                                                                                                                                                                                                                    Searches for DN's of all objects defined by filter in given base ("sub")

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string base

                                                                                                                                                                                                                                                                                                                                                                                                    • string search_filter

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> - of DN's (list of strings)

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.44. ReadTemplates

                                                                                                                                                                                                                                                                                                                                                                                                    Read object templates from LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - error message

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.45. RestartSSHD

                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of restart_sshd (= restart sshd during write)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean restart

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.46. Set

                                                                                                                                                                                                                                                                                                                                                                                                    Only set variables, without checking anything

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.47. SetAnonymous

                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of 'anonymous' variable (= bind without password)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean anon

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.48. SetBaseDN

                                                                                                                                                                                                                                                                                                                                                                                                    Set new LDAP base DN

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string new_base_dn

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.49. SetBindPassword

                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of bind_pass variable

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string pass

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.50. SetDefaults

                                                                                                                                                                                                                                                                                                                                                                                                    Set the defualt values, which should replace the ones from Read () Used during instalation, when we want to do a reasonable proposal

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.51. SetGUI

                                                                                                                                                                                                                                                                                                                                                                                                    Set the value of 'use_gui' variable (= show error popups)

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean gui

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.52. SetReadSettings

                                                                                                                                                                                                                                                                                                                                                                                                    set the value of read_settings variable which means, do not read some settings from system

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean read

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.53. ShortSummary

                                                                                                                                                                                                                                                                                                                                                                                                    returns html formated configuration summary (shorter than Summary)

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - summary

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.54. SingleValued

                                                                                                                                                                                                                                                                                                                                                                                                    Check if attribute allowes only single or multiple value

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • string attr

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - answer

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.55. Summary

                                                                                                                                                                                                                                                                                                                                                                                                    Summary() returns html formated configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • string - summary

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.56. UpdatedArchPackages

                                                                                                                                                                                                                                                                                                                                                                                                    Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.57. Write

                                                                                                                                                                                                                                                                                                                                                                                                    Saves LDAP configuration.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • symbol

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.58. WriteLDAP

                                                                                                                                                                                                                                                                                                                                                                                                    Writes map of objects to LDAP. Ask for password, when needed and shows the error message when necessary.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map objects

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.59. WriteNow

                                                                                                                                                                                                                                                                                                                                                                                                    wrapper for Write, without abort block

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.60. WriteOpenLdapConf

                                                                                                                                                                                                                                                                                                                                                                                                    Modify also /etc/openldap/ldap.conf for the use of ldap client utilities (like ldapsearch)

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - modified?

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.61. WritePlusLine

                                                                                                                                                                                                                                                                                                                                                                                                    If a file does not + entry, add it.

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean login

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success?

                                                                                                                                                                                                                                                                                                                                                                                                    136.3.62. WriteToLDAP

                                                                                                                                                                                                                                                                                                                                                                                                    Writes map of objects to LDAP

                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • map objects

                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                    • map - error map (empty on success)

                                                                                                                                                                                                                                                                                                                                                                                                    Example 23. 

                                                                                                                                                                                                                                                                                                                                                                                                     TODO


                                                                                                                                                                                                                                                                                                                                                                                                    136.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.1. _autofs_allowed

                                                                                                                                                                                                                                                                                                                                                                                                    If no, automounter will not be affected.

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.2. _start_autofs

                                                                                                                                                                                                                                                                                                                                                                                                    Start automounter and import the settings from LDAP

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.3. attr_types

                                                                                                                                                                                                                                                                                                                                                                                                    Map of atribute types (from schema). Indexed by names.

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.4. available_config_modules

                                                                                                                                                                                                                                                                                                                                                                                                    Available configuration modules (objectClass names) TODO update

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.5. base_config_dn

                                                                                                                                                                                                                                                                                                                                                                                                    DN of base configuration object

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.6. bind_dn

                                                                                                                                                                                                                                                                                                                                                                                                    DN for binding to LDAP server

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.7. file_server

                                                                                                                                                                                                                                                                                                                                                                                                    If home directories of LDAP users are stored on this machine

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.8. hash_schemas

                                                                                                                                                                                                                                                                                                                                                                                                    encryption schemes supported by slappasswd

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.9. initial_defaults

                                                                                                                                                                                                                                                                                                                                                                                                    The defualt values, which should replace the ones from Read () Used during instalation, when we want to do a reasonable proposal

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.10. initial_defaults_used

                                                                                                                                                                                                                                                                                                                                                                                                    If the default values, used from ldap-server module were used to configure ldap-client

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.11. login_enabled

                                                                                                                                                                                                                                                                                                                                                                                                    If login of LDAP uses to local machine is enabled

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.12. member_attribute

                                                                                                                                                                                                                                                                                                                                                                                                    which attribute have LDAP groups for list of members

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.13. mkhomedir

                                                                                                                                                                                                                                                                                                                                                                                                    if pam_mkhomedir is set in /etc/pam.d/commond-session

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.14. new_objects

                                                                                                                                                                                                                                                                                                                                                                                                    defaults for adding new config objects and templates

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.15. nis_available

                                                                                                                                                                                                                                                                                                                                                                                                    Is NIS service available? If yes, and LDAP client will be enabled, warn user (see bug #36981)

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.16. object_classes

                                                                                                                                                                                                                                                                                                                                                                                                    Map of object classes (from schema). Indexed by names.

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.17. read_settings

                                                                                                                                                                                                                                                                                                                                                                                                    If false, do not read settings already set from outside used e.g. for Users YaPI. see bug #60898

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.18. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                    Required packages for this module to operate -- they are now required only when LDAP is set for authentication

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.19. restart_sshd

                                                                                                                                                                                                                                                                                                                                                                                                    if sshd should be restarted during write phase

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.20. server

                                                                                                                                                                                                                                                                                                                                                                                                    IP addresses of LDAP server.

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.21. start

                                                                                                                                                                                                                                                                                                                                                                                                    Are LDAP services available via nsswitch.conf?

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.22. use_gui

                                                                                                                                                                                                                                                                                                                                                                                                    show popups with error messages?

                                                                                                                                                                                                                                                                                                                                                                                                    136.4.23. write_only

                                                                                                                                                                                                                                                                                                                                                                                                    Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                    136.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                    136.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                    • Arch
                                                                                                                                                                                                                                                                                                                                                                                                    • Autologin
                                                                                                                                                                                                                                                                                                                                                                                                    • DNS
                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                    • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                    • Hostname
                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                    • Message
                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                    • Nsswitch
                                                                                                                                                                                                                                                                                                                                                                                                    • Package
                                                                                                                                                                                                                                                                                                                                                                                                    • Pam
                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                    • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                    • Service
                                                                                                                                                                                                                                                                                                                                                                                                    • Stage
                                                                                                                                                                                                                                                                                                                                                                                                    • Summary

                                                                                                                                                                                                                                                                                                                                                                                                    136.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                    • ldap/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                    137. LdapDatabase

                                                                                                                                                                                                                                                                                                                                                                                                    137.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                      137.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                          137.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                          137.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                          137.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                          137.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                          • Label
                                                                                                                                                                                                                                                                                                                                                                                                          • Ldap
                                                                                                                                                                                                                                                                                                                                                                                                          • LdapPopup
                                                                                                                                                                                                                                                                                                                                                                                                          • LdapServer
                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                          • Sequencer
                                                                                                                                                                                                                                                                                                                                                                                                          • String
                                                                                                                                                                                                                                                                                                                                                                                                          • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                          137.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                          • helps.ycp

                                                                                                                                                                                                                                                                                                                                                                                                          138. LdapPopup

                                                                                                                                                                                                                                                                                                                                                                                                          Additional user interface functions: special edit popups

                                                                                                                                                                                                                                                                                                                                                                                                          138.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                          • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                          138.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                          • AddDefaultValue - Popup for adding new default value (default value is template's attribute)

                                                                                                                                                                                                                                                                                                                                                                                                          • BrowseTree - Popup for browsing LDAP tree and selecting the DN WARNING we expect that LDAP connection is already correctly initialized !

                                                                                                                                                                                                                                                                                                                                                                                                          • EditAttribute - Generic popup for editing attribute's value

                                                                                                                                                                                                                                                                                                                                                                                                          • InitAndBrowseTree - Open the LDAP Browse popup and initialize initialize LDAP connection before.

                                                                                                                                                                                                                                                                                                                                                                                                          • NewModule - Popup for adding new configuration module

                                                                                                                                                                                                                                                                                                                                                                                                          • PasswordPolicyDialog - dialog for Password Policy configuration object

                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                            138.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.1. AddDefaultValue

                                                                                                                                                                                                                                                                                                                                                                                                            Popup for adding new default value (default value is template's attribute)

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • list available

                                                                                                                                                                                                                                                                                                                                                                                                            • list conflicts

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • map - of new "default value" (contains attribute name and value)

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.2. BrowseTree

                                                                                                                                                                                                                                                                                                                                                                                                            Popup for browsing LDAP tree and selecting the DN WARNING we expect that LDAP connection is already correctly initialized !

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • string root_dn

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • string - DN of selected item, empty string when canceled

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.3. EditAttribute

                                                                                                                                                                                                                                                                                                                                                                                                            Generic popup for editing attribute's value

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - of atrtibute values (edited or unchanged)

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.4. InitAndBrowseTree

                                                                                                                                                                                                                                                                                                                                                                                                            Open the LDAP Browse popup and initialize initialize LDAP connection before.

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • string root_dn

                                                                                                                                                                                                                                                                                                                                                                                                            • map connection

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • string - DN of selected item, empty string when canceled

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.5. NewModule

                                                                                                                                                                                                                                                                                                                                                                                                            Popup for adding new configuration module

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • list available

                                                                                                                                                                                                                                                                                                                                                                                                            • list conflicts

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • map - of new module (contains its name and object class)

                                                                                                                                                                                                                                                                                                                                                                                                            138.3.6. PasswordPolicyDialog

                                                                                                                                                                                                                                                                                                                                                                                                            dialog for Password Policy configuration object

                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                            • map ppolicy

                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                            • map - with modifications of ppolicy object, nil in case of `cancel

                                                                                                                                                                                                                                                                                                                                                                                                            138.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                            138.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                            138.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                            • Ldap
                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                            • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                            138.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                              139. LinuxUserMgmt

                                                                                                                                                                                                                                                                                                                                                                                                              LinuxUserMgmt settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                              139.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                              • Stephen T. Bunch <sbunch@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                              139.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                              • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                              • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                              • Export - Dump the linux-user-mgmt settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                              • Import - Get all linux-user-mgmt settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                              • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                              • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                              • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Read all linux-user-mgmt settings

                                                                                                                                                                                                                                                                                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                              • Write - Write all linux-user-mgmt settings

                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                              139.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                              Abort function

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                              Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                              Dump the linux-user-mgmt settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                              Get all linux-user-mgmt settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                              Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                                                              Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                              Read all linux-user-mgmt settings

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                                                              Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                              139.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                                                              Write all linux-user-mgmt settings

                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                              139.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                              139.4.1. Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Settings Map

                                                                                                                                                                                                                                                                                                                                                                                                              139.4.2. modified

                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                              139.4.3. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                              139.4.4. write_only

                                                                                                                                                                                                                                                                                                                                                                                                              Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                              139.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                              139.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                              • EdirUtilsLUM
                                                                                                                                                                                                                                                                                                                                                                                                              • Misc
                                                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                                                              • NovellLDAPLUM
                                                                                                                                                                                                                                                                                                                                                                                                              • NovellUtilsLUM
                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                              • Service
                                                                                                                                                                                                                                                                                                                                                                                                              • Summary

                                                                                                                                                                                                                                                                                                                                                                                                              139.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                140. Linuxrc

                                                                                                                                                                                                                                                                                                                                                                                                                140.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                • Anas Nashif <nashif@suse.de?

                                                                                                                                                                                                                                                                                                                                                                                                                140.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                • WriteYaSTInf - Write /etc/yast.inf during installation

                                                                                                                                                                                                                                                                                                                                                                                                                • braille - braille mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                • display_ip - remote X mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                • serial_console - running via serial console

                                                                                                                                                                                                                                                                                                                                                                                                                • text - we're running in textmode (-> UI::GetDisplayInfo())

                                                                                                                                                                                                                                                                                                                                                                                                                • usessh - ssh mode ? if booted with 'vnc=1 usessh=1', keep vnc mode, but start sshd if booted with 'display_ip=1.2.3.4 usessh=1', keep remote X mode, but start sshd this has to be checked by the caller, not here

                                                                                                                                                                                                                                                                                                                                                                                                                • vnc - vnc mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.1. WriteYaSTInf

                                                                                                                                                                                                                                                                                                                                                                                                                  Write /etc/yast.inf during installation

                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,string> linuxrc

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.2. braille

                                                                                                                                                                                                                                                                                                                                                                                                                  braille mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.3. display_ip

                                                                                                                                                                                                                                                                                                                                                                                                                  remote X mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.4. serial_console

                                                                                                                                                                                                                                                                                                                                                                                                                  running via serial console

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.5. text

                                                                                                                                                                                                                                                                                                                                                                                                                  we're running in textmode (-> UI::GetDisplayInfo())

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.6. usessh

                                                                                                                                                                                                                                                                                                                                                                                                                  ssh mode ? if booted with 'vnc=1 usessh=1', keep vnc mode, but start sshd if booted with 'display_ip=1.2.3.4 usessh=1', keep remote X mode, but start sshd this has to be checked by the caller, not here

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.3.7. vnc

                                                                                                                                                                                                                                                                                                                                                                                                                  vnc mode ?

                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  140.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                  140.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                  140.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                  140.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                    141. LiveInstaller

                                                                                                                                                                                                                                                                                                                                                                                                                    141.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                      141.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                          141.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                          141.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                          141.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                                                                                                                                                                          142. LogView

                                                                                                                                                                                                                                                                                                                                                                                                                          Displaying a log with additional functionality

                                                                                                                                                                                                                                                                                                                                                                                                                          142.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                          142.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                          • AdvancedHelp - Get the second part of the help for the log in case of advanced functions

                                                                                                                                                                                                                                                                                                                                                                                                                          • AdvancedSaveHelp - Get the second part of the help for the log in case of advanced functions and save support

                                                                                                                                                                                                                                                                                                                                                                                                                          • CreateWidget - Get the map with the log view widget

                                                                                                                                                                                                                                                                                                                                                                                                                          • Display - Main function for displaying logs

                                                                                                                                                                                                                                                                                                                                                                                                                          • DisplayFiltered - Display log with filtering with 100 lines

                                                                                                                                                                                                                                                                                                                                                                                                                          • DisplaySimple - Display specified file, list 100 lines

                                                                                                                                                                                                                                                                                                                                                                                                                          • LogHandle - Handle the event on the log view widget

                                                                                                                                                                                                                                                                                                                                                                                                                          • LogInit - Initialize the displayed log

                                                                                                                                                                                                                                                                                                                                                                                                                          • LogSelectionHelp - Get the help for the log in case of multiple logs

                                                                                                                                                                                                                                                                                                                                                                                                                          • SaveHelp - Get the second part of the help for the log in case of save support

                                                                                                                                                                                                                                                                                                                                                                                                                          • SingleLogHelp - Get the help for the log in case of a single log

                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.1. AdvancedHelp

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the second part of the help for the log in case of advanced functions

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string label

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • string - part of the log

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.2. AdvancedSaveHelp

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the second part of the help for the log in case of advanced functions and save support

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string label

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • string - part of the log

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.3. CreateWidget

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the map with the log view widget

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,any> parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map<string,any> > log_files

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • map - the log widget

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.4. Display

                                                                                                                                                                                                                                                                                                                                                                                                                            Main function for displaying logs

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, any> parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.5. DisplayFiltered

                                                                                                                                                                                                                                                                                                                                                                                                                            Display log with filtering with 100 lines

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                            • string grep

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.6. DisplaySimple

                                                                                                                                                                                                                                                                                                                                                                                                                            Display specified file, list 100 lines

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.7. LogHandle

                                                                                                                                                                                                                                                                                                                                                                                                                            Handle the event on the log view widget

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string key

                                                                                                                                                                                                                                                                                                                                                                                                                            • map event

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol - always nil

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.8. LogInit

                                                                                                                                                                                                                                                                                                                                                                                                                            Initialize the displayed log

                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                            • string key

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.9. LogSelectionHelp

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the help for the log in case of multiple logs

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • string - part of the log

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.10. SaveHelp

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the second part of the help for the log in case of save support

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • string - part of the log

                                                                                                                                                                                                                                                                                                                                                                                                                            142.3.11. SingleLogHelp

                                                                                                                                                                                                                                                                                                                                                                                                                            Get the help for the log in case of a single log

                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                            • string - part of the log

                                                                                                                                                                                                                                                                                                                                                                                                                            142.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                            142.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                            142.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                            • CWM
                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                            • LogViewCore
                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                            • Report

                                                                                                                                                                                                                                                                                                                                                                                                                            142.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                              143. LogViewCore.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                              Displaying a log

                                                                                                                                                                                                                                                                                                                                                                                                                              143.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                              • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                              143.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                              • Start - Starts the log reading command via process agent.

                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                143.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                143.3.1. Start

                                                                                                                                                                                                                                                                                                                                                                                                                                Starts the log reading command via process agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                • term widget

                                                                                                                                                                                                                                                                                                                                                                                                                                • map<string, any> d

                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                143.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                143.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                143.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                143.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                  144. Mail

                                                                                                                                                                                                                                                                                                                                                                                                                                  Data for configuration of mail, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                  • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                  • CreateConfig - If MAIL_CREATE_CONFIG is not yes, the user does not want SuSEconfig to modify sendmail.cf/main.cf. So we will warn him before setting it to yes.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Export - Dump the mail settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fake - Make up data for screnshots

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import - Get all mail settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProbePackages - Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read - Read all mail settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Summary - Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Touch - A convenient shortcut for setting touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Write - Update the SCR according to mail settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                  • amavis_allowed - Is amavis available on the installation media?

                                                                                                                                                                                                                                                                                                                                                                                                                                  • connection_type - `permanent, `dialup or `none

                                                                                                                                                                                                                                                                                                                                                                                                                                  • fetchmail - List of maps: $[server:, protocol:, remote_user:, local_user:, password:, enabled:(bool), other_(server|client)_options: ]

                                                                                                                                                                                                                                                                                                                                                                                                                                  • fetchmail_mode - When should fetchmail run: <dl> <dt> `manual <dd> <dt> `ppp <dd> for a ppp conection, /etc/ppp/ip-{up,down}.d <dt> `network <dd> for any network connection, /etc/sysconfig/network/if-{up,down}.d </dl> #22903 Unused yet! #37139, just enable rcfetchmail.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • from_header - Mail will appear to come from this domain. Applies also for the envelope. Does not apply for mail from root.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • install_packages - Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                  • listen_remote - If false, port 25 will listen only for localhost

                                                                                                                                                                                                                                                                                                                                                                                                                                  • local_domains - Domains for locally delivered mail. (ahost.acompany.com is a domain)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • masquerade_other_domains - If empty, from_header will be applied to mails coming from local_domains, otherwise from these domains. (Remember: mail domains)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • masquerade_users - User specific sender masquerading. List of maps: $[comment:, user:, address:] (all are strings)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • mta - `sendmail, `postfix or `other Initialized by ReadMta

                                                                                                                                                                                                                                                                                                                                                                                                                                  • outgoing_mail_server - A relay server for outgoing mail. May be enclosed in [brackets] to prevent MX lookups.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • postfix_mda - sysconfig/postfix:POSTFIX_MDA #26052

                                                                                                                                                                                                                                                                                                                                                                                                                                  • protocol_choices - Fetchmail protocols, as defined in rcfile_l.l Probably not all of them are compatible with our simplified scheme but it does not hurt to include them. Must check for validity: the agent matches [[:alnum:]]+, lowercase names are valid too.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • remove_packages - Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                  • required_packages - Required packages

                                                                                                                                                                                                                                                                                                                                                                                                                                  • smtp_auth - SMTP AUTH (#23000) list of maps: The ui only handles the first list item, the rest is for autoyast $[server: string, user: string, password: string(plain text)] There are other map keys that must be preserved on editing.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • smtp_use_TLS - Do the MTA use TLS for sending the email.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • touched - Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                  • use_amavis - Use a virus scanner (AMaViS). amavisd-new (mta-independent) must be installed. It will be installed if amavis_allowed and it is not installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • virtual_users - Domain-specific aliases. List of maps: $[comment:, alias:, destinations:] (all are strings)

                                                                                                                                                                                                                                                                                                                                                                                                                                  • write_only - If true, don't run SuSEconfig or restart the services. Autoinstall uses this to do all in one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.2. CreateConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                  If MAIL_CREATE_CONFIG is not yes, the user does not want SuSEconfig to modify sendmail.cf/main.cf. So we will warn him before setting it to yes.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - Is it yes?

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                  Dump the mail settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.4. Fake

                                                                                                                                                                                                                                                                                                                                                                                                                                  Make up data for screnshots

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.5. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                  Get all mail settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • map Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.6. ProbePackages

                                                                                                                                                                                                                                                                                                                                                                                                                                  Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - "" or "Foo will be installed.\nBar will be installed.\n"

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.7. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                  Read all mail settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.8. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                  Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - with summary of configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.9. Touch

                                                                                                                                                                                                                                                                                                                                                                                                                                  A convenient shortcut for setting touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean really

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                  Example 24. 

                                                                                                                                                                                                                                                                                                                                                                                                                                   Mail::Touch (Mail::var != ui_var);


                                                                                                                                                                                                                                                                                                                                                                                                                                  144.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                  Update the SCR according to mail settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.1. amavis_allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                  Is amavis available on the installation media?

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.2. connection_type

                                                                                                                                                                                                                                                                                                                                                                                                                                  `permanent, `dialup or `none

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.3. fetchmail

                                                                                                                                                                                                                                                                                                                                                                                                                                  List of maps: $[server:, protocol:, remote_user:, local_user:, password:, enabled:(bool), other_(server|client)_options: ]

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.4. fetchmail_mode

                                                                                                                                                                                                                                                                                                                                                                                                                                  When should fetchmail run: <dl> <dt> `manual <dd> <dt> `ppp <dd> for a ppp conection, /etc/ppp/ip-{up,down}.d <dt> `network <dd> for any network connection, /etc/sysconfig/network/if-{up,down}.d </dl> #22903 Unused yet! #37139, just enable rcfetchmail.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.5. from_header

                                                                                                                                                                                                                                                                                                                                                                                                                                  Mail will appear to come from this domain. Applies also for the envelope. Does not apply for mail from root.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.6. install_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                  Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.7. listen_remote

                                                                                                                                                                                                                                                                                                                                                                                                                                  If false, port 25 will listen only for localhost

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.8. local_domains

                                                                                                                                                                                                                                                                                                                                                                                                                                  Domains for locally delivered mail. (ahost.acompany.com is a domain)

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.9. masquerade_other_domains

                                                                                                                                                                                                                                                                                                                                                                                                                                  If empty, from_header will be applied to mails coming from local_domains, otherwise from these domains. (Remember: mail domains)

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.10. masquerade_users

                                                                                                                                                                                                                                                                                                                                                                                                                                  User specific sender masquerading. List of maps: $[comment:, user:, address:] (all are strings)

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.11. mta

                                                                                                                                                                                                                                                                                                                                                                                                                                  `sendmail, `postfix or `other Initialized by ReadMta

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.12. outgoing_mail_server

                                                                                                                                                                                                                                                                                                                                                                                                                                  A relay server for outgoing mail. May be enclosed in [brackets] to prevent MX lookups.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.13. postfix_mda

                                                                                                                                                                                                                                                                                                                                                                                                                                  sysconfig/postfix:POSTFIX_MDA #26052

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.14. protocol_choices

                                                                                                                                                                                                                                                                                                                                                                                                                                  Fetchmail protocols, as defined in rcfile_l.l Probably not all of them are compatible with our simplified scheme but it does not hurt to include them. Must check for validity: the agent matches [[:alnum:]]+, lowercase names are valid too.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.15. remove_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                  Read only, set by ProbePackages. Use as an argument to Package::DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.16. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                  Required packages

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.17. smtp_auth

                                                                                                                                                                                                                                                                                                                                                                                                                                  SMTP AUTH (#23000) list of maps: The ui only handles the first list item, the rest is for autoyast $[server: string, user: string, password: string(plain text)] There are other map keys that must be preserved on editing.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.18. smtp_use_TLS

                                                                                                                                                                                                                                                                                                                                                                                                                                  Do the MTA use TLS for sending the email.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.19. touched

                                                                                                                                                                                                                                                                                                                                                                                                                                  Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.20. use_amavis

                                                                                                                                                                                                                                                                                                                                                                                                                                  Use a virus scanner (AMaViS). amavisd-new (mta-independent) must be installed. It will be installed if amavis_allowed and it is not installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.21. virtual_users

                                                                                                                                                                                                                                                                                                                                                                                                                                  Domain-specific aliases. List of maps: $[comment:, alias:, destinations:] (all are strings)

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.4.22. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                  If true, don't run SuSEconfig or restart the services. Autoinstall uses this to do all in one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                  • MailAliases
                                                                                                                                                                                                                                                                                                                                                                                                                                  • MailTable
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                  • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                  • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                  144.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                    145. MailAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                    Data for configuration of mail aliases, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                    • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                    • FilterRootAlias - Separates aliases into aliases, root_alias and root_alias_comment

                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetRootAlias - For use by the Users package. Does not rely on the internal state, first calls the agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • MergeRootAlias -

                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadAliases - Read the aliases table (and separate the root alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                    • SetRootAlias - For use by the Users package. Does not use the internal state, just calls the agent. SuSEconfig or newaliases is NOT called! (TODO: what if it is called while the main module is running?) Errors are reported via Report::Error.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • WriteAliases - Part of Write.

                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                    • aliases - List of maps: $[comment:, alias:, destinations:] (all are strings) Except root.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • root_alias - Separated/joined with aliases by read/write/set/export

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.1. FilterRootAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                    Separates aliases into aliases, root_alias and root_alias_comment

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.2. GetRootAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                    For use by the Users package. Does not rely on the internal state, first calls the agent.

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - eg. "joe, \\root", "" if not defined

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.3. MergeRootAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> - prepend root alias data to aliases, if set

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.4. ReadAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                    Read the aliases table (and separate the root alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success?

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.5. SetRootAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                    For use by the Users package. Does not use the internal state, just calls the agent. SuSEconfig or newaliases is NOT called! (TODO: what if it is called while the main module is running?) Errors are reported via Report::Error.

                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                    • string destinations

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.3.6. WriteAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                    Part of Write.

                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                    • SetRootAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.4.1. aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                    List of maps: $[comment:, alias:, destinations:] (all are strings) Except root.

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.4.2. root_alias

                                                                                                                                                                                                                                                                                                                                                                                                                                    Separated/joined with aliases by read/write/set/export

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                    • MailTable

                                                                                                                                                                                                                                                                                                                                                                                                                                    145.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                      146. MailServer

                                                                                                                                                                                                                                                                                                                                                                                                                                      MailServer settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Peter Varkoly <varkoly@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                      • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                      • CheckPackages - Check if all needed packages are installed

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export - Dump the mail-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import - Get all mail-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read - Read all mail-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Write - Write all mail-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                      Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - blah blah lahjk

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.3. CheckPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if all needed packages are installed

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.4. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                      Dump the mail-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.5. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                      Get all mail-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                      • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                      Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.7. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.8. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                      Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.9. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                      Read all mail-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                      Write all mail-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.1. AdminPassword

                                                                                                                                                                                                                                                                                                                                                                                                                                      Some additional parameter needed for the configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.2. CertExist

                                                                                                                                                                                                                                                                                                                                                                                                                                      True if there is server certificate.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.3. FetchingMail

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server fetching mail jobs.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.4. GlobalSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server global settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.5. LDAPDefaults

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server local domains.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.6. MailLocalDelivery

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server local delivery settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.7. MailLocalDomains

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server local domains.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.8. MailPrevention

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server prevention settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.9. MailRelaying

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail server relaying settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.10. MailTransports

                                                                                                                                                                                                                                                                                                                                                                                                                                      Map of the mail transport settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.11. ModulesTreeContent

                                                                                                                                                                                                                                                                                                                                                                                                                                      List of the Configuration Modules

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.12. PPPCards

                                                                                                                                                                                                                                                                                                                                                                                                                                      List of the PPP devices

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.13. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.14. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.15. setup

                                                                                                                                                                                                                                                                                                                                                                                                                                      True if the modul was started with the option 'setup'.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.4.16. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                      Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Ldap
                                                                                                                                                                                                                                                                                                                                                                                                                                      • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Users
                                                                                                                                                                                                                                                                                                                                                                                                                                      • YaPI::MailServer

                                                                                                                                                                                                                                                                                                                                                                                                                                      146.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                        147. Map

                                                                                                                                                                                                                                                                                                                                                                                                                                        Map manipulation routines

                                                                                                                                                                                                                                                                                                                                                                                                                                        147.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                        147.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                        • CheckKeys - Check if a map contains all needed keys

                                                                                                                                                                                                                                                                                                                                                                                                                                        • FromString - Convert string "var=val ..." to map $[val:var, ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Keys - Return all keys from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                        • KeysToLower - Switch map keys to lower case

                                                                                                                                                                                                                                                                                                                                                                                                                                        • KeysToUpper - Switch map keys to upper case

                                                                                                                                                                                                                                                                                                                                                                                                                                        • ToString - Convert options map $[var:val, ...] to string "var=val ..."

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Values - Return all values from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.1. CheckKeys

                                                                                                                                                                                                                                                                                                                                                                                                                                          Check if a map contains all needed keys

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map m

                                                                                                                                                                                                                                                                                                                                                                                                                                          • list keys

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if map kontains all keys

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.2. FromString

                                                                                                                                                                                                                                                                                                                                                                                                                                          Convert string "var=val ..." to map $[val:var, ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - converted string

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.3. Keys

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return all keys from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map m

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • list - a list of all keys from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.4. KeysToLower

                                                                                                                                                                                                                                                                                                                                                                                                                                          Switch map keys to lower case

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string, any> m

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - with keys converted to lower case

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.5. KeysToUpper

                                                                                                                                                                                                                                                                                                                                                                                                                                          Switch map keys to upper case

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string, any> m

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - with keys converted to lower case

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.6. ToString

                                                                                                                                                                                                                                                                                                                                                                                                                                          Convert options map $[var:val, ...] to string "var=val ..."

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map m

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - converted map

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.3.7. Values

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return all values from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • map m

                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                          • list - a list of all values from the map

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                          • String

                                                                                                                                                                                                                                                                                                                                                                                                                                          147.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                            148. Message

                                                                                                                                                                                                                                                                                                                                                                                                                                            Often used messages

                                                                                                                                                                                                                                                                                                                                                                                                                                            148.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                            • Copyright: Copyright 2004, Novell, Inc. All rights reserved.

                                                                                                                                                                                                                                                                                                                                                                                                                                            148.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.1. CannotAdjustService

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot ajust 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string service_name

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot adjust 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.2. CannotContinueWithoutPackagesInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot continue without required packages installed

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot continue without required packages installed

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.3. CannotOpenFile

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot open file 'file'

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot open file 'file'

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.4. CannotOpenFileBecause

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot open file 'file'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot open file 'file'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.5. CannotReadCurrentSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                              When is is not able to read current settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot read current settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.6. CannotRestartService

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot restart 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string service_name

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot restart 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.7. CannotStartService

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot start 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string service_name

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot start 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.8. CannotStopService

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot stop 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string service_name

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot stop 'service_name' service

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.9. CannotWriteSettingsTo

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot write settings to 'destination'

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string destination

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot write settings to 'destination'

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.10. CannotWriteSettingsToBecause

                                                                                                                                                                                                                                                                                                                                                                                                                                              Cannot write settings to 'destination'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string destination

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Cannot write settings to 'destination'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.11. CheckEnvironment

                                                                                                                                                                                                                                                                                                                                                                                                                                              Check the environment

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Check the environment

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.12. DirectoryDoesNotExistCreate

                                                                                                                                                                                                                                                                                                                                                                                                                                              Question: Directory does not exist. Create it?

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string directory

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - The directory '%1' does not exist.\nCreate it?

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.13. DoNotShowMessageAgain

                                                                                                                                                                                                                                                                                                                                                                                                                                              Push Button / CheckBox for not to disturb with this message again

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Do Not Show This Message &Again

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.14. DomainHasChangedMustReboot

                                                                                                                                                                                                                                                                                                                                                                                                                                              Domain has changed, you have to reboot now for domain to take effect

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - The domain has changed.\nYou must reboot for the changes to take effect.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.15. ErrorWritingFile

                                                                                                                                                                                                                                                                                                                                                                                                                                              Error writing file 'file'

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Error writing file 'file'

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.16. ErrorWritingFileBecause

                                                                                                                                                                                                                                                                                                                                                                                                                                              Error writing file 'file'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Error writing file 'file'\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.17. FailedToInstallPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                              Installing packages failed

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Failed to install required packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.18. Finished

                                                                                                                                                                                                                                                                                                                                                                                                                                              Finished

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Finished

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.19. MissingParameter

                                                                                                                                                                                                                                                                                                                                                                                                                                              When some parameter is missing

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Missing parameter '%1'.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.20. RequiredItem

                                                                                                                                                                                                                                                                                                                                                                                                                                              Required text item

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - This item is required to be filled in

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.21. SuSEConfigFailed

                                                                                                                                                                                                                                                                                                                                                                                                                                              Running SuSEConfig failed

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - SuSEconfig script failed.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.22. UnableToCreateDirectory

                                                                                                                                                                                                                                                                                                                                                                                                                                              When is is not able to create directory

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string directory

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - Unable to create directory '%1'.

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.3.23. UnknownError

                                                                                                                                                                                                                                                                                                                                                                                                                                              UnknownError\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - UnknownError\n\nReason: reason

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                              148.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                              none

                                                                                                                                                                                                                                                                                                                                                                                                                                              149. MiniWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                              149.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                              • Tiny wrapper around Sequencer and Wizard.

                                                                                                                                                                                                                                                                                                                                                                                                                                              149.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                  149.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                  149.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                  149.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                  149.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Sequencer
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                  149.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                    150. Misc

                                                                                                                                                                                                                                                                                                                                                                                                                                                    150.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    150.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CustomSysconfigRead - Try to read value from sysconfig file and return the result if successful. Function reads from arbitrary sysconfig file, for which the agent doesn't exist: e.g. from different partition like /mnt/etc/sysconfig/file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadAlternateFile -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SplitOptions - MergeOptions Merges "opt1=val1 opt2=val2 ..." and $["opta":"vala", ..."] to $["opt1":"val1", "opt2":"val2", "opta":"vala", ...] as needed by modules.conf agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SysconfigRead - SysconfigRead()

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SysconfigWrite - SysconfigWrite()

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • hardware_name -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • translate -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.1. CustomSysconfigRead

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Try to read value from sysconfig file and return the result if successful. Function reads from arbitrary sysconfig file, for which the agent doesn't exist: e.g. from different partition like /mnt/etc/sysconfig/file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string defval

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string location

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - Success --> Result of SCR::Read<br> Failure --> Default value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 25. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                       Misc::CustomSysconfigRead ("INSTALLED_LANGUAGES", "", Installation::destdir + "/etc/sysconfig/language");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.2. ReadAlternateFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string first

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string second

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • any - content of file try to read first file, if it doesn't exist, read second files must reside below /usr/lib/YaST2 files must have ycp syntax

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.3. SplitOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                      MergeOptions Merges "opt1=val1 opt2=val2 ..." and $["opta":"vala", ..."] to $["opt1":"val1", "opt2":"val2", "opta":"vala", ...] as needed by modules.conf agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string options

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map optmap

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - $["opt1":"val1", "opt2":"val2", ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.4. SysconfigRead

                                                                                                                                                                                                                                                                                                                                                                                                                                                      SysconfigRead()

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path sysconfig_path

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string defaultv

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - Success --> Result of SCR::Read<br> Failure --> Default value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.5. SysconfigWrite

                                                                                                                                                                                                                                                                                                                                                                                                                                                      SysconfigWrite()

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path level

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<list> values

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - false if SCR::Write reported error write list of sysyconfig entries via rcconfig agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.6. hardware_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map hardware_entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - vendor and device name common function to extract 'name' of hardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.3.7. translate

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map lmap

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string lang

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - translation Define a macro that looks up a localized string in a language map of the form $[ "default" : "Defaultstring", "de" : "German....", ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                      150.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                      151. Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Installation mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                      151.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                      151.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Initialize - initialize everything from command-line of y2base

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • autoinst - doing auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • commandline - we're running in command line interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • config - configuration for auto-installation, only in running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • installation - we're doing a fresh installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • live_installation - we're doing a fresh installation from live CD/DVD

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • mode - Returns the current mode name. It's one of "installation", "normal", "update", "repair", "autoinstallation", "autoinst_config"

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • normal - normal, running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • repair - start repair module

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • screen_shot - dump screens to /tmp. Implies @ref #demo . See installation/Test-Scripts/yast2-screen-shots*

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • test - Just testing. See installation/Test-Scripts/doit*

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • testsuite - Returns whether running in testsuite.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ui - Returns the current UI mode. It's one of "commandline", "dialog", "none"

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • update - we're doing an update

                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.1. Initialize

                                                                                                                                                                                                                                                                                                                                                                                                                                                        initialize everything from command-line of y2base

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.2. autoinst

                                                                                                                                                                                                                                                                                                                                                                                                                                                        doing auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.3. commandline

                                                                                                                                                                                                                                                                                                                                                                                                                                                        we're running in command line interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if command-line is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.4. config

                                                                                                                                                                                                                                                                                                                                                                                                                                                        configuration for auto-installation, only in running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.5. installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        we're doing a fresh installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.6. live_installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        we're doing a fresh installation from live CD/DVD

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.7. mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the current mode name. It's one of "installation", "normal", "update", "repair", "autoinstallation", "autoinst_config"

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.8. normal

                                                                                                                                                                                                                                                                                                                                                                                                                                                        normal, running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.9. repair

                                                                                                                                                                                                                                                                                                                                                                                                                                                        start repair module

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.10. screen_shot

                                                                                                                                                                                                                                                                                                                                                                                                                                                        dump screens to /tmp. Implies @ref #demo . See installation/Test-Scripts/yast2-screen-shots*

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.11. test

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Just testing. See installation/Test-Scripts/doit*

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.12. testsuite

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether running in testsuite.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.13. ui

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns the current UI mode. It's one of "commandline", "dialog", "none"

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.3.14. update

                                                                                                                                                                                                                                                                                                                                                                                                                                                        we're doing an update

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                        151.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                        none

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152. Modem

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Modem data

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Add - Add a new device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Adding - Used to see whether we are in the process of adding a new interface or editing an existing one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Commit - Commit the pending operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Delete - Delete the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Edit - Edit the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Overview - Create an overview table with all configured devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Read all network settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Select - Select the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SelectHW - Select the hardware component

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary - Create a textual summary and a list of unconfigured devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AbortFunction - Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • hotplug - Hotplug type ("" if not hot pluggable)

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Add a new device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.2. Adding

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Used to see whether we are in the process of adding a new interface or editing an existing one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - adding?

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.3. Commit

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Commit the pending operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.4. Delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.5. Edit

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Edit the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.6. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.7. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.8. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.9. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create an overview table with all configured devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.10. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read all network settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.11. Select

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.12. SelectHW

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the hardware component

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer which

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.13. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a textual summary and a list of unconfigured devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean split

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.3.14. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.4.2. hotplug

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hotplug type ("" if not hot pluggable)

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NetworkService
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Routing
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSEFirewall4Network
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                        152.5.2. Module Includes

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                        153. ModuleLoading

                                                                                                                                                                                                                                                                                                                                                                                                                                                        153.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Klaus Kaempf <kkaempf@suse.de> (initial)

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Purpose:

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • This module does all module loading stuff.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        153.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.3.1. Load

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string modulename

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string moduleargs

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string vendorname

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string devicename

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean ask_before_loading

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean with_modprobe

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol - : `dont user choose *not* to load module `ok module loaded ok `fail module loading failed load a module if not already loaded by linuxrc

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.3.2. prepareVendorDeviceInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map controller

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list - [string vendor, string device] Convert internal probing data to user readable string for module loading.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ModuleLoading::Load

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Icon
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                          153.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                            154. ModulesComments

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Library for handling special comments in /etc/modules.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                            154.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                            154.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ExtractFromComment - Extacts the unique key and the name of the card from comment in the modules.conf placed before the alias differentiatin the card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StoreToComment - Create comment for modules.conf from the unique key and the name of the card. It will be parsed when reading. This comment should be placed before the alias differentiating the card (char-major-81-x for TV cards, ethx for ethernet, ...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                              154.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                              154.3.1. ExtractFromComment

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Extacts the unique key and the name of the card from comment in the modules.conf placed before the alias differentiatin the card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - Returns map: $[ "unique_key" : string, "name" : string ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 26. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ModulesComments::ExtractFromComment ("# xyza.aiLKJkjsdlj:Ultra brutal TV card\n")
                                                                                                                                                                                                                                                                                                                                                                                                                                                               -> $[ "name" : "Ultra brutal TV card", "unique_key" : "xyza.aiLKJkjsdlj" ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                              154.3.2. StoreToComment

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create comment for modules.conf from the unique key and the name of the card. It will be parsed when reading. This comment should be placed before the alias differentiating the card (char-major-81-x for TV cards, ethx for ethernet, ...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string unique_key

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - The comment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 27. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ModulesComments::StoreToComment ("Ultra brutal TV card", "xyza.aiLKJkjsdlj")
                                                                                                                                                                                                                                                                                                                                                                                                                                                               -> "# xyza.aiLKJkjsdlj:Ultra brutal TV card\n"


                                                                                                                                                                                                                                                                                                                                                                                                                                                              154.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                              154.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                              none

                                                                                                                                                                                                                                                                                                                                                                                                                                                              155. ModulesConf

                                                                                                                                                                                                                                                                                                                                                                                                                                                              All modules.conf related functions are here

                                                                                                                                                                                                                                                                                                                                                                                                                                                              155.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Klaus Kaempf (kkaempf@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                              155.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ModuleArgs - ModuleArgs save arguments for a kernel module

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RunDepmod - RunDepmod runs /sbin/depmod !! call only when SCR runs on target !!

                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Save - Save save module names and arguments to /etc/modules.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.3.1. ModuleArgs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                ModuleArgs save arguments for a kernel module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string arg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.3.2. RunDepmod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                RunDepmod runs /sbin/depmod !! call only when SCR runs on target !!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.3.3. Save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Save save module names and arguments to /etc/modules.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Kernel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                155.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  156. Mouse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  156.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    156.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        156.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        156.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        156.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        156.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        156.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          157. Multipath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          157.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            157.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3.2. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read all multipath settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3.3. ReadDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read settings dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3.4. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write all multipath settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.3.5. WriteDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write settings dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Confirm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PackagesProposal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              157.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • multipath/complex.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • multipath/helps.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158. NetHwDetection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Network detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • result - Detection result (in dhcpcd-<i>interface</i>.info format)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • running - True, if detection is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.3.1. DuplicateIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Duplicate IP detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if duplicate found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • arping(8), ip(8)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.3.2. ResolveIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Resolve IP to hostname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - resolved host

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.3.3. Start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Start the detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.3.4. Stop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Stop the detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.4.1. result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Detection result (in dhcpcd-<i>interface</i>.info format)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.4.2. running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              True, if detection is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              158.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • network/hardware.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              159. Netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Netmask manipulation routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              159.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              159.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Check - Check the netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Check4 - Check the IPv4 netmask Note that 0.0.0.0 is not a correct netmask.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Check6 - Check the IPv6 netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FromBits - Convert netmask in bits form (20) to netmask string (255.255.240.0)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ToBits - Convert IPv4 netmask as string (255.255.240.0) to bits form (20)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3.1. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Check the netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3.2. Check4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Check the IPv4 netmask Note that 0.0.0.0 is not a correct netmask.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3.3. Check6

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Check the IPv6 netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3.4. FromBits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Convert netmask in bits form (20) to netmask string (255.255.240.0)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer bits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - netmask string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.3.5. ToBits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Convert IPv4 netmask as string (255.255.240.0) to bits form (20)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string netmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer - number of bits in netmask; 32 for empty string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                159.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                160. Network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Network data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                160.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                160.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    160.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    160.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    160.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    160.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    160.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161. NetworkConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Network configuration data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export - Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import - Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read - Read all network settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Write - Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Config - Basic network settings (/etc/sysconfig/network/config)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • DHCP - DHCP settings (/etc/sysconfig/network/dhcp)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3.2. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3.3. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3.4. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Read all network settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.3.5. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.4.1. Config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Basic network settings (/etc/sysconfig/network/config)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.4.2. DHCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DHCP settings (/etc/sysconfig/network/dhcp)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      161.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162. NetworkInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface manipulation (/etc/sysconfig/network/ifcfg-*)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Add - Add a new device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CanonicalizeIP - Canonicalize netmask data (#46885) Sysconfig allows: IPADDR=10.0.0.1/8 IPADDR=10.0.0.1 PREFIXLEN=8 IPADDR=10.0.0.1 NETMASK=255.0.0.0 (IPADDR overrides PREFIXLEN, NETMASK used only if prefix length unspecified) If prefix length and NETMASK are unspecified, 32 is implied. Canonicalize it to IPADDR=10.0.0.1 PREFIXLEN= NETMASK=255.0.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CanonicalizeStartmode - STARTMODE: onboot, on and boot are aliases for auto

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Check - Check presence of the device (alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CleanCacheRead - re-read all settings again from system for creating new proposal from scratch (#170558)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CleanHotplugSymlink - Clean the hotplug devices compatibility symlink, usually ifcfg-eth-pcmcia -> ifcfg-eth-pcmcia-0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ConcealSecrets - Conceal secret information, such as WEP keys, so that the output can be passed to y2log and bugzilla. (#65741)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ConcealSecrets1 - Conceal secret information, such as WEP keys, so that the output can be passed to y2log and bugzilla.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Delete - Delete the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DeleteAlias - Add the alias to the list of deleted items. Called when exiting from the aliases-of-device dialog. #48191

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Edit - Edit the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Fastest - Find the fastest available device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FilterDevices - Used in BuildSummary, BuildOverview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetDevTypeDescription - Return textual device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetDeviceType - Return device type in human readable form :-)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetDeviceTypes - Return supported network device types (for type netcard) for this hardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetFreeDevice - Return free device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetFreeDevicesOld - Compute free devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetIP - get IP addres + additional IP addresses

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HasAliases - Check if the given device has any virtual alias.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • IsConnected - Test whether device is connected (Link:up) The info is taken from sysfs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • IsHotplug - Test hotplugability of a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • List - Get devices of the given type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ListDevicesExcept - list of all devices except given one by parameter dev also loopback is ommited

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Locate - Locate devices of the given type and value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LocateNOT - Locate devices of the given type and value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LocateProvider - Check if any device is using the specified provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Modified - Were the devices changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Push - DSL needs to save its config while the underlying network card is being configured.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Read devices from files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • RealType - Return real type of the device (incl. PCMCIA, USB, ...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Select - Select the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • UpdateModemSymlink - Update /dev/modem symlink

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidCharsIfcfg - #46803: forbid "/" (filename), maybe also "-" (separator) "_" (escape)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Write devices to files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • alias_name - Create a alias name from its type and numbers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • alias_num - Return a device alias number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • device_name - Create a device name from its type and number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • device_num - Return a device number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • device_type - Return a device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CardRegex - Predefined network card regular expressions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Current - Current device information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DeviceRegex - Predefined network device regular expressions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Name - Current device identifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • report_every_check - False suppresses tones of logs 'NetworkInterfaces.ycp:ABC Check(eth,id-00:aa:bb:cc:dd:ee,)'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Add a new device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.2. CanonicalizeIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Canonicalize netmask data (#46885) Sysconfig allows: IPADDR=10.0.0.1/8 IPADDR=10.0.0.1 PREFIXLEN=8 IPADDR=10.0.0.1 NETMASK=255.0.0.0 (IPADDR overrides PREFIXLEN, NETMASK used only if prefix length unspecified) If prefix length and NETMASK are unspecified, 32 is implied. Canonicalize it to IPADDR=10.0.0.1 PREFIXLEN= NETMASK=255.0.0.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> ifcfg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> - the map with IPADDR, NETMASK adjusted; PREFIXLEN "" others unchanged. If IPADDR is empty, return the original.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.3. CanonicalizeStartmode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        STARTMODE: onboot, on and boot are aliases for auto

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> ifcfg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.4. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check presence of the device (alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if device is present

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.5. CleanCacheRead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        re-read all settings again from system for creating new proposal from scratch (#170558)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.6. CleanHotplugSymlink

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Clean the hotplug devices compatibility symlink, usually ifcfg-eth-pcmcia -> ifcfg-eth-pcmcia-0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.7. ConcealSecrets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Conceal secret information, such as WEP keys, so that the output can be passed to y2log and bugzilla. (#65741)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map devs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - ifcfgs with secret fields masked out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.8. ConcealSecrets1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Conceal secret information, such as WEP keys, so that the output can be passed to y2log and bugzilla.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> ifcfg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - ifcfg with secret fields masked out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.9. Delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.10. DeleteAlias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Add the alias to the list of deleted items. Called when exiting from the aliases-of-device dialog. #48191

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string aid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.11. Edit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Edit the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.12. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> - dumped settings (later acceptable by Import())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.13. Fastest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Find the fastest available device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.14. FilterDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Used in BuildSummary, BuildOverview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.15. GetDevTypeDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return textual device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean longdescr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - textual form of device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 28. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetDevTypeDescription("eth", false) -> "Ethernet"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetDevTypeDescription("eth", true)  -> "Ethernet Network Card"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.16. GetDeviceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return device type in human readable form :-)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 29. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetDeviceType(eth-bus-pci-0000:01:07.0) -> "Network Card"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetDeviceType(modem0) -> "Modem"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.17. GetDeviceTypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return supported network device types (for type netcard) for this hardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.18. GetFreeDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return free device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - free device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 30. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetFreeDevice("eth") -&gt; "1"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.19. GetFreeDevicesOld

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Compute free devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - num of free devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 31. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         GetFreeDevices("eth", 2) -&gt; [ 1, 2 ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.20. GetIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get IP addres + additional IP addresses

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - of IP addresses of selected interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.21. HasAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check if the given device has any virtual alias.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if there are some aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.22. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.23. IsConnected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Test whether device is connected (Link:up) The info is taken from sysfs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if connected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.24. IsHotplug

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Test hotplugability of a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if hotpluggable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.25. List

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get devices of the given type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - of found devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.26. ListDevicesExcept

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        list of all devices except given one by parameter dev also loopback is ommited

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.27. Locate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Locate devices of the given type and value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - of devices with key=val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.28. LocateNOT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Locate devices of the given type and value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - of devices with key!=val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.29. LocateProvider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check if any device is using the specified provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if there is any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.30. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Were the devices changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.31. Push

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DSL needs to save its config while the underlying network card is being configured.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.32. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read devices from files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if sucess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.33. RealType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return real type of the device (incl. PCMCIA, USB, ...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string hotplug

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - real type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 32. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         RealType("eth", "usb") -> "eth-usb"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.34. Select

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Select the given device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.35. UpdateModemSymlink

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update /dev/modem symlink

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.36. ValidCharsIfcfg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        #46803: forbid "/" (filename), maybe also "-" (separator) "_" (escape)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.37. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Write devices to files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string devregex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 33. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         NetworkDevice::Write("eth|tr");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.38. alias_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a alias name from its type and numbers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string typ

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string anum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - alias name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 34. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         alias_name("eth", "1", "2") -> "eth1#2"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.39. alias_num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a device alias number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - alias number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 35. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         alias_num("eth1#2") -> "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         alias_num("eth1#blah") -> "blah"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.40. device_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a device name from its type and number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string typ

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - device name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 36. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_name("eth", "1") -> "eth1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_name("lo", "") -> "lo"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.41. device_num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a device number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - device number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 37. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_num("eth1") -> "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_num("lo") -> ""


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.3.42. device_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return a device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - device type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 38. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_type("eth1") -> "eth"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         device_type("eth-pcmcia-0") -> "eth-pcmcia"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4.1. CardRegex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Predefined network card regular expressions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4.2. Current

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Current device information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4.3. DeviceRegex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Predefined network device regular expressions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4.4. Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Current device identifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.4.5. report_every_check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        False suppresses tones of logs 'NetworkInterfaces.ycp:ABC Check(eth,id-00:aa:bb:cc:dd:ee,)'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Netmask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        162.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          163. NetworkPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Popup dialogs for browsing the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          163.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          163.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ChooseItem - Let the user choose one of a list of items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • HostName - Give me one host name on the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • NFSExport - Give me export path of selected server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • NFSServer - Give me NFS server name on the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.3.1. ChooseItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Let the user choose one of a list of items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - one item or nil

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.3.2. HostName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Give me one host name on the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - a hostname or nil if "Cancel" was pressed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.3.3. NFSExport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Give me export path of selected server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - an export or nil if "Cancel" was pressed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.3.4. NFSServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Give me NFS server name on the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - a hostname or nil if "Cancel" was pressed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NetworkInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            163.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              164. NetworkService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Init script handling, ifup vs NetworkManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              164.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              164.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ConfirmNetworkManager - Opens up a continue/cancel confirmation popup in the case when NetworkManager is enabled. User is informed that continuing the configuration may produce undefined results. If NetworkManager is not used, silently returns true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • EnableDisable - Enables and disables the appropriate services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IsManaged - Whether use NetworkManager or ifup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Initialize module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RunningNetworkPopup - If there is network running, return true. Otherwise show error popup depending on Mode and return false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetManaged -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • StartStop - Starts and stops the appropriate services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.1. ConfirmNetworkManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Opens up a continue/cancel confirmation popup in the case when NetworkManager is enabled. User is informed that continuing the configuration may produce undefined results. If NetworkManager is not used, silently returns true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - continue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.2. EnableDisable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enables and disables the appropriate services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.3. IsManaged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether use NetworkManager or ifup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.4. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Initialize module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.5. RunningNetworkPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If there is network running, return true. Otherwise show error popup depending on Mode and return false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if network running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.6. SetManaged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean m

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.3.7. StartStop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Starts and stops the appropriate services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • NetworkConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                164.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  165. NetworkStorage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Networked disks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  165.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  165.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • isDiskOnNetwork - If the disk is on a networked device (NFS, ISCSI), the main NIC needs STARTMODE nfsroot instead of auto.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.3.1. isDiskOnNetwork

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If the disk is on a networked device (NFS, ISCSI), the main NIC needs STARTMODE nfsroot instead of auto.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - root dev over network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FileUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    165.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      166. NewID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      166.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      166.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.3.1. Activate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Activate value stored in the internal list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - True if all settings were successfuly set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.3.2. MakeProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return new ID description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - (string) list of hardware desciptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        166.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • hwinfo/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167. Nfs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NFS client configuration data, I/O functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Dan Vesely <dan@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Dump the NFS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Get all NFS configuration from a map. When called by nfs_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mount - Mount NFS directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Reads NFS settings from the SCR (.etc.fstab)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Set - Set module data

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary - Summary()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Unmount - Unmount NFS directory from the system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Writes the NFS client configuration and starts/stops the service. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • WriteOnly - Writes the NFS client configuration without starting/stopping the service. Autoinstallation uses this and then calls SuSEconfig only once and starts the services together. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Dump the NFS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - a list of nfs entries.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.3. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all NFS configuration from a map. When called by nfs_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map> settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.5. Mount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Mount NFS directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string share

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string mpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - directory where volume was mounted or nil if mount failed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.6. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reads NFS settings from the SCR (.etc.fstab)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.7. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map> settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.8. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Summary()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - Html formatted configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.10. Unmount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Unmount NFS directory from the system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string mpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writes the NFS client configuration and starts/stops the service. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.3.12. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writes the NFS client configuration without starting/stopping the service. Autoinstallation uses this and then calls SuSEconfig only once and starts the services together. (No parameters because it is too short to abort)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.4.1. nfs_entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eg.: [ $["spec": "moon:/cheese", file: "/mooncheese", "mntopts": "defaults"], ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.4.2. non_nfs_entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read only, intended for checking mount-point uniqueness.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.4.3. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        167.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nfs/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168. NfsServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NFS server configuration data, I/O functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Dump the NFS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Get all NFS server configuration from a map. When called by nfs_server_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Reads NFS settings from the SCR (.etc.exports), from SCR (.sysnconfig.nfs) and SCR (.etc.idmapd_conf),if necessary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Set - Set the variables just as is and without complaining

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Saves NFS server configuration. (exports(5)) Creates any missing directories.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • WriteExports - Saves /etc/exports and creates missing directories.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • domain - Domain name to be used for nfsv4 (idmapd.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enable_nfsv4 - Enable nfsv4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exports -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nfs_security - GSS Security ?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • required_packages - Required packages for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • start - Should the server be started? New since 9.0: Exports are independent of this setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Dump the NFS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - $["start_nfsserver": "nfs_exports":]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.3. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all NFS server configuration from a map. When called by nfs_server_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • exports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.5. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reads NFS settings from the SCR (.etc.exports), from SCR (.sysnconfig.nfs) and SCR (.etc.idmapd_conf),if necessary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.6. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the variables just as is and without complaining

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.7. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.8. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - A summary for autoyast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.9. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Saves NFS server configuration. (exports(5)) Creates any missing directories.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.3.10. WriteExports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Saves /etc/exports and creates missing directories.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.1. domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Domain name to be used for nfsv4 (idmapd.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.2. enable_nfsv4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enable nfsv4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.3. exports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.4. nfs_security

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GSS Security ?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.5. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required packages for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.6. start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Should the server be started? New since 9.0: Exports are independent of this setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.4.7. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        168.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169. Nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          NIS client configuration data, I/O functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Dan Vesely <dan@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • AutoPackages - Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • BrItem - Makes an item for the short summary. I guess the users module wants to avoid paragraph breaks.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DomainChanged - If the domain has changed from a nonempty one, it may only be changed at boot time. Use this to warn the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - Dump the NIS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Fake - Make up data for screnshots. To be used instead of @ref Read .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetDomain -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetServers -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import - Get all the NIS configuration from a map. When called by nis_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ProbePackages - Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read - Reads NIS settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set - Set module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetDomain - Set the NIS domain.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetServers - Set the servers from a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ShortSummary - Create a short textual summary with configuration abstract It is called by "authentication/user sources" dialog in yast2-users

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Touch - A convenient shortcut for setting touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • UsersByLdap - Used in the UI when NIS is turned on.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Saves NIS configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • WriteNssConf - Configures the name service switch for the user databases according to chosen settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • WriteOnly - Only write new configuration w/o starting any scripts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • check_address_nis - Check syntax of a network address (ip4 or name), names only if nsswitch.conf does not have hosts: nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • check_nisdomainname - Check syntax of a NIS domain name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • getNetconfigValues - Read Netconfig configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • setNetconfigValues - Write the netconfig configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid_address_nis - Describe a valid address - ip4 or name, names only if nsswitch.conf does not have hosts: nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid_nisdomainname -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • YpbindErrors - Output of "rcypbind start", if there was an error. Read only. This is currently used only in nis-server for its more advanced error reporting. (Bug 14706)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • _autofs_allowed - If no, automounter will not be affected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • _start_autofs - Start automounter and import the settings from NIS. (Bug 6092)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • broken_server - You should set this to "yes" if you have a NIS server in your network, which binds only to high ports over 1024. Since this is a security risk, you should consider to replace the NIS server with another implementation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default_broadcast - Broadcast for the default domain? (New in ypbind-1.12)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • dhcp_restart - If dhcp_wanted changes, we need to restart the DHCP client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • dhcpcd_running - #35654: if the server is running and sysconfig wants NIS data, it's ok to FitIntoSingle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • global_broadcast - If this option is set, ypbind will ignore /etc/yp.conf and use a broadcast call to find a NIS server in the local subnet. You should avoid to use this, it is a big security risk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • install_packages - Read only, set by ProbePackages. Use as an argument to DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • local_only - If this option is set, ypbind will only bind to the loopback interface and remote hosts cannot query it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • multidomain_broadcast - Servers for a multiple-domain configuration. Whether a broadcast will be done if the servers don't respond. Keys are domains, values are booleans. The domains must be the same as for multidomain_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • multidomain_servers - Servers for a multiple-domain configuration. Keys are domains, values are lists of servers (strings). The domains must be the same as for multidomain_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • options - Extra options for ypbind. Here you can add options like "-ypset", "-ypsetme", "-p port" or "-no-ping".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • required_packages - Required packages for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • servers - IP addresses of NIS servers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • start - Should ypbind be started at boot? If not, other settings are not touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • touched - Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - of lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.2. BrItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Makes an item for the short summary. I guess the users module wants to avoid paragraph breaks.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - [b]title[/b]: value[br]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.3. DomainChanged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If the domain has changed from a nonempty one, it may only be changed at boot time. Use this to warn the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - whether changed by SetDomain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.4. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Dump the NIS settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - $["start":, "servers":[...], "domain":]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.5. Fake

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Make up data for screnshots. To be used instead of @ref Read .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.6. GetDomain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Get the NIS domain.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.7. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.8. GetServers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Access the servers as a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.9. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get all the NIS configuration from a map. When called by nis_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.10. ProbePackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Detect which packages have to be installed and return a descriptive string for a plain text pop-up.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - "" or "Foo will be installed.\nBar will be installed.\n"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.11. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Reads NIS settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.12. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.13. SetDomain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the NIS domain.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string new_domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.14. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.15. SetServers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the servers from a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string servers_s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.16. ShortSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a short textual summary with configuration abstract It is called by "authentication/user sources" dialog in yast2-users

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.17. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Html formatted configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.18. Touch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A convenient shortcut for setting touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean really

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 39. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           Nis::Touch (Nis::var != ui_var);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.19. UsersByLdap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Used in the UI when NIS is turned on.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.20. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Saves NIS configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.21. WriteNssConf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Configures the name service switch for the user databases according to chosen settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.22. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Only write new configuration w/o starting any scripts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.23. check_address_nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check syntax of a network address (ip4 or name), names only if nsswitch.conf does not have hosts: nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string a

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.24. check_nisdomainname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check syntax of a NIS domain name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.25. getNetconfigValues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read Netconfig configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.26. setNetconfigValues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Write the netconfig configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.27. valid_address_nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Describe a valid address - ip4 or name, names only if nsswitch.conf does not have hosts: nis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - a description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.3.28. valid_nisdomainname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - describe a valid NIS domain name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.1. YpbindErrors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Output of "rcypbind start", if there was an error. Read only. This is currently used only in nis-server for its more advanced error reporting. (Bug 14706)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.2. _autofs_allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If no, automounter will not be affected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.3. _start_autofs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Start automounter and import the settings from NIS. (Bug 6092)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.4. broken_server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          You should set this to "yes" if you have a NIS server in your network, which binds only to high ports over 1024. Since this is a security risk, you should consider to replace the NIS server with another implementation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.5. default_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Broadcast for the default domain? (New in ypbind-1.12)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.6. dhcp_restart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If dhcp_wanted changes, we need to restart the DHCP client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.7. dhcpcd_running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          #35654: if the server is running and sysconfig wants NIS data, it's ok to FitIntoSingle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.8. global_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If this option is set, ypbind will ignore /etc/yp.conf and use a broadcast call to find a NIS server in the local subnet. You should avoid to use this, it is a big security risk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • multidomain_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.9. install_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read only, set by ProbePackages. Use as an argument to DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.10. local_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If this option is set, ypbind will only bind to the loopback interface and remote hosts cannot query it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.11. multidomain_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Servers for a multiple-domain configuration. Whether a broadcast will be done if the servers don't respond. Keys are domains, values are booleans. The domains must be the same as for multidomain_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • multidomain_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • global_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.12. multidomain_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Servers for a multiple-domain configuration. Keys are domains, values are lists of servers (strings). The domains must be the same as for multidomain_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • multidomain_broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.13. options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Extra options for ypbind. Here you can add options like "-ypset", "-ypsetme", "-p port" or "-no-ping".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.14. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required packages for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.15. servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IP addresses of NIS servers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.16. start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Should ypbind be started at boot? If not, other settings are not touched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.4.17. touched

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Has the configuration been changed? Can be used as an argument to Popup::ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Autologin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Nsswitch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          169.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170. NisServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NIS Server, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Dan Vesely <dan@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Client - Calls NIS client configuration writing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • EnsureDirectory - Ensures that the domain directory exists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Export - Dump the nisServer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetAllMaps - All tables that ypserv Makefile knows about

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetSaveList - Returns a list of what to save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Import - Get all nisServer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Read - Read all NIS server settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Remove - Removes file or directory and log errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SaveSecurenets - Save securenets list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SaveSlaves - Save list of slaves by calling appropriate any agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SaveVariables - Saves config variables according to workflow

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Write - Write all NIS server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • YPDaemons - Starts or stop daemons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • YPGetMaps - Gets the YP maps from master for slave

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • YPMake - Creates initial database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • addError - Adds an error to error_msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • addErrorDetail - Adds an error to error_details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • getMaster - Gets the master server (name or IP?) from any of this server's maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • isYPMaster -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • isYPServerInstalled -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • dhcp_changes_domain - If DHCP client could change domain name (#28727)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • domain - The domain we are serving. (for simplicity, we assume a single domain) US ".etc.defaultdomain"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • maps - Maps to be served

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • merge_passwd - Merge passwd and shadow to one map? Makefile: string true|false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • mingid - Minimal GID to include in the user maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • minuid - Minimal UID to include in the user maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • nisclient_local - NIS client is configured localy (with current machine as server)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • nopush - Don't push the changes to slave servers. (useful if there aren't any) Makefile: string true|false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • old_domainname - For warning if the domain was changed. TODO delegate to the client module?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pwd_chfn - YPPWD_CHFN - allow changing the full name?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pwd_chsh - YPPWD_CHSH - allow changing the login shell?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pwd_srcdir - YPPWD_SRCDIR - source directory for passwd data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • required_packages - Packages to be installed for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • securenets -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • start_ypbind - Start also the client? (only when client is configured locally)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • start_yppasswdd - Start also the password daemon?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • start_ypxfrd - Start also the map transfer daemon?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ui_master_ip - If we are a slave, where is the master? (it may actually be a hostname, TODO solve like in the client using nsswitch)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ui_what - What kind of server to run: `master, `slave, `none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ypservers - Slave servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.1. Client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Calls NIS client configuration writing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.2. EnsureDirectory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures that the domain directory exists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - false if not and cannot be created

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the nisServer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.4. GetAllMaps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            All tables that ypserv Makefile knows about

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.5. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.6. GetSaveList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a list of what to save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - a list of maps: <pre>$[ "save_label": ..., "progress_label": ..., "function": @see CallFunction01 ]</pre>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.7. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all nisServer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all NIS server settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.9. Remove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Removes file or directory and log errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • any file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.10. SaveSecurenets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Save securenets list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.11. SaveSlaves

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Save list of slaves by calling appropriate any agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.12. SaveVariables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saves config variables according to workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • any which

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.13. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.14. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.15. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all NIS server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.16. YPDaemons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Starts or stop daemons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • any workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.17. YPGetMaps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gets the YP maps from master for slave

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.18. YPMake

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Creates initial database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.19. addError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds an error to error_msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.20. addErrorDetail

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds an error to error_details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.21. getMaster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gets the master server (name or IP?) from any of this server's maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - nil if no map is found or it has no YP_MASTER_NAME

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.22. isYPMaster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Determines if the current host is YP master or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.3.23. isYPServerInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Checks if the YP server software is installed by querying RPM for ypserv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.1. dhcp_changes_domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If DHCP client could change domain name (#28727)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.2. domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The domain we are serving. (for simplicity, we assume a single domain) US ".etc.defaultdomain"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.3. maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Maps to be served

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.4. merge_passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Merge passwd and shadow to one map? Makefile: string true|false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.5. mingid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimal GID to include in the user maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.6. minuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimal UID to include in the user maps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.7. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.8. nisclient_local

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NIS client is configured localy (with current machine as server)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.9. nopush

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Don't push the changes to slave servers. (useful if there aren't any) Makefile: string true|false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.10. old_domainname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            For warning if the domain was changed. TODO delegate to the client module?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.11. pwd_chfn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            YPPWD_CHFN - allow changing the full name?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.12. pwd_chsh

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            YPPWD_CHSH - allow changing the login shell?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.13. pwd_srcdir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            YPPWD_SRCDIR - source directory for passwd data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.14. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Packages to be installed for this module to operate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.15. securenets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            securenet
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              network: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              netmask: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            * or
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hash: "#"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) comment: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.16. start_ypbind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Start also the client? (only when client is configured locally)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.17. start_yppasswdd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Start also the password daemon?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.18. start_ypxfrd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Start also the map transfer daemon?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.19. ui_master_ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If we are a slave, where is the master? (it may actually be a hostname, TODO solve like in the client using nsswitch)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.20. ui_what

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            What kind of server to run: `master, `slave, `none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.21. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.4.22. ypservers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Slave servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DNS
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Nis
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Nis
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            170.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171. NovellCasa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              NovellCasa settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • casa <casa@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ********************************************************************

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Copyright (C) 2005-2006 Novell, Inc. All Rights Reserved.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • This library is free software; you can redistribute it and/or

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • modify it under the terms of the GNU Lesser General Public

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • License as published by the Free Software Foundation; version 2.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • of the License.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • This library is distributed in the hope that it will be useful,

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • but WITHOUT ANY WARRANTY; without even the implied warranty of

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Library Lesser General Public License for more details.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • You should have received a copy of the GNU Lesser General Public

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • License along with this library; if not, Novell, Inc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • To contact Novell about this file by physical or electronic mail,

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • you may find current contact information at www.novell.com.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ********************************************************************

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Representation of the configuration of CASA.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Input and output routines.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Export - Dump the CASA settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Import - Get all CASA settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Read all CASA settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Write - Write all CASA settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Dump the CASA settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all CASA settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read all CASA settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write all CASA settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              171.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                172. NovellLDAPLUM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dialogs definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                172.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Reed Haslam <Reed_Haslam@Novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                172.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    172.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    172.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    172.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    172.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EdirUtilsLUM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NovellUtilsLUM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NovellValidatorsLUM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    172.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • linux-user-mgmt/helps.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    173. NovellUtilsLUM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Novell utility routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    173.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stephen T. Bunch <sbunch@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    173.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CheckForInstalledSoftware - CheckForInstalledSoftware()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FindValueInRegistry - Find a value in the Novell registry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetDefaultAndFallbackIPAddresses - Determine what the default and fallback IP addresses should be for a product.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetIPAddr - Function: global string GetIPAddr()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IsEdirectoryInstalledLocally - See if eDirectory is installed locally on this machine and is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IsSelectionInstalled - See if the specified product was installed during phase 1 of the install. This is how we determine if a product should show up in the proposal screen. The input parameter "selection_name" should match the name of the selection file for which information is required (e.g. novell-imanager, novell-ifolder2, X11, Linux_tools, etc.). The parameter "selection_name" is not case sensitive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MapIPAddrToDevice - Function: MapIPAddrToDevice(string ip)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReplaceSubString - Function: ReplaceSubString(string text, string replace, string replacement)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Typeful2Typeless - Typeful2Typeless (string ndsName)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ValidatePassword - Validate password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.1. CheckForInstalledSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CheckForInstalledSoftware()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.2. FindValueInRegistry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Find a value in the Novell registry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - registry value for key on success, nil string on failure or no value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.3. GetDefaultAndFallbackIPAddresses

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Determine what the default and fallback IP addresses should be for a product.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string ldapIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.4. GetIPAddr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function: global string GetIPAddr()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.5. IsEdirectoryInstalledLocally

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See if eDirectory is installed locally on this machine and is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.6. IsSelectionInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See if the specified product was installed during phase 1 of the install. This is how we determine if a product should show up in the proposal screen. The input parameter "selection_name" should match the name of the selection file for which information is required (e.g. novell-imanager, novell-ifolder2, X11, Linux_tools, etc.). The parameter "selection_name" is not case sensitive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string selection_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.7. MapIPAddrToDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function: MapIPAddrToDevice(string ip)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.8. ReplaceSubString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function: ReplaceSubString(string text, string replace, string replacement)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string replace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string replacement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.9. Typeful2Typeless

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Typeful2Typeless (string ndsName)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string ndsName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.3.10. ValidatePassword

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Validate password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string pw1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string pw2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      173.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        174. NovellValidatorsLUM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Novell validation routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        174.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stephen T. Bunch <sbunch@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        174.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateContext - Validate Context

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateCredentials - Validate credentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateDNSorIP - Validate DNS or IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateFDN - Validate FDN. If the name is optional pass in 'true' as the second param, otherwise pass in 'false'. In some cases we allow an optional name, in others the name is manditory. Returns true if the fully distiguished name is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateIP - Validate IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidateIPMsg - Validate IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidatePassword - Validate password Returns true if the password is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidatePasswords - Validate passwords Returns true if the passwords are valid and match, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ValidatePort - Validate port, is it a valid number and is it already in use. Displays an warning to the user if the port is in use. Returns true if the port is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.1. ValidateContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate Context

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.2. ValidateCredentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate credentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string userName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean doFeedback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.3. ValidateDNSorIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate DNS or IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.4. ValidateFDN

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate FDN. If the name is optional pass in 'true' as the second param, otherwise pass in 'false'. In some cases we allow an optional name, in others the name is manditory. Returns true if the fully distiguished name is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.5. ValidateIP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.6. ValidateIPMsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate IP address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.7. ValidatePassword

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate password Returns true if the password is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string pw1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.8. ValidatePasswords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate passwords Returns true if the passwords are valid and match, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string pw1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string pw2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.3.9. ValidatePort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Validate port, is it a valid number and is it already in use. Displays an warning to the user if the port is in use. Returns true if the port is valid, else false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • NovellUtilsLUM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          174.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            175. Nsswitch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Configuration of /etc/nsswitch.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            175.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            175.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadDb - Reads a database entry from nsswitch_conf and returns it as a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Write - Writes the edited files to the disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • WriteAutofs - Configures the name service switch for autofs according to chosen settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • WriteDb - Writes a database entry as a list to nsswitch_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.3.1. ReadDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Reads a database entry from nsswitch_conf and returns it as a list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string db

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> - eg. ["files", "nis"]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.3.2. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Writes the edited files to the disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.3.3. WriteAutofs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Configures the name service switch for autofs according to chosen settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - success?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.3.4. WriteDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Writes a database entry as a list to nsswitch_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string db

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - success?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              175.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176. NtpClient

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data for configuration of ntp-client, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ad_controller - Active Directory controller

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • change_firewall - Should the firewall settings be changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • firewall_services - ports in firewall to open

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ntp_policy - Netconfig policy: for merging and prioritizing static and DHCP config. FIXME get a public URL https://svn.suse.de/svn/sysconfig/branches/mt/dhcp6-netconfig/netconfig/doc/README

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ntp_records - Read all ntp-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • random_pool_servers - List of servers defined by the pool.ntp.org to get random ntp servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • required_packages - Required packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • run_chroot - Should the daemon be started in chroot environment?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • run_service - Should the daemon be started when system boots?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_index - Index of the currently sellected item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_record - The currently sellected item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • service_name - Service name of the NTP daemon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.1. ActivateRandomPoolServersFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add servers needed for random_pool_servers function into the current configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.3. DeActivateRandomPoolServersFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Removes all servers contained in the random_pool_servers list from the current configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.4. DetectNtpServers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Detect NTP servers present in the local network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol method

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> - a list of found NTP servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.5. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dump the ntp-client settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.6. GetAllKnownCountries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Reads and returns all known countries with their country codes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map <string, string> - of known contries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "CL" : "Chile",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "FR" : "France",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.7. GetCountryNames

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the mapping between country codea and names ("CZ" -> "Czech Republic")

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map<string, string> - a map the country codes and names mapping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.8. GetCurrentLanguageCode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read current language (RC_LANG from sysconfig)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - two-letter language code (cs_CZ.UTF-8 -> CZ)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.9. GetNtpServers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the list of known NTP servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map<string, map<string,string> > - a list of known NTP servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.10. GetNtpServersByCountry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get list of public NTP servers for a country

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string country

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean terse_output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - of servers (usable as combo-box items)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.11. GetUsedNtpServers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function returns list of NTP servers used in the configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <string> - of servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.12. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all ntp-client settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.13. IsRandomServersServiceEnabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checks whether all servers listed in the random_pool_servers list are used in the configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.14. ProcessNtpConf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read and parse /etc.ntp.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.15. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all ntp-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.16. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.17. TestNtpServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Test if specified NTP server answers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol verbosity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if NTP server answers properly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.18. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write all ntp-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.19. deleteSyncRecord

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete specified synchronization record

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.20. findSyncRecord

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Find index of synchronization record

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string address

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer - index of the record if found, -1 otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.21. getSyncRecords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the list of synchronization-related records

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<map<string,any> > - a list of maps with keys type (eg. "server"), address and index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.22. selectSyncRecord

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Select synchronization record

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.3.23. storeSyncRecord

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Store currently sellected synchronization record

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.1. ad_controller

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Active Directory controller

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.2. change_firewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Should the firewall settings be changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.3. firewall_services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ports in firewall to open

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.4. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.5. ntp_policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Netconfig policy: for merging and prioritizing static and DHCP config. FIXME get a public URL https://svn.suse.de/svn/sysconfig/branches/mt/dhcp6-netconfig/netconfig/doc/README

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.6. ntp_records

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all ntp-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.7. random_pool_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of servers defined by the pool.ntp.org to get random ntp servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • http://www.pool.ntp.org/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.8. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.9. run_chroot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Should the daemon be started in chroot environment?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.10. run_service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Should the daemon be started when system boots?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.11. selected_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index of the currently sellected item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.12. selected_record

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The currently sellected item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.13. service_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Service name of the NTP daemon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.4.14. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileChanges
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SLPAPI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                176.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177. OSR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Control of the automatic scan and repair sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.1. CheckGroupRequires

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  check the dependencies for seleced detect groups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.2. Detect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Start detection loop.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.3. DetectGroupList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  get value of OSRCommon::detect_group_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.4. GroupItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Build item list with all group items.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<term>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.5. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This method initializes the YaST OS Repair system. It is started at first and builds the main window, initializes the global osr_map and a lot of other data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True if the initialization progress succeeded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.6. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset all.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.7. ResetDetect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset detect settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.8. ResetDetectGroupList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  set OSRCommon::detect_group_list to []

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.9. ResetDetectionModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset the temporary changes. e.g.: Umount temporary mounted partitions ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.10. SetDetectGroupList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  set new value for OSRCommon::detect_group_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> gl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.11. SetReboot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Prepare for reboot system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.12. SizeDetectGroupList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return size of OSRCommon::detect_group_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.3.13. osr_empty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Empty term.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.4.1. next_detect_method

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Allowed back jump in a scan and repair sequence error appear.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRDirect
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRProgress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRSummary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  177.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • repair/osr_module_bootloader.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • repair/osr_module_init.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • repair/osr_module_packages.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • repair/osr_module_partition.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178. OSRBoot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Bootloader checks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.1. BootloaderPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return all needed packages of a boot loader.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string bootloader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.2. CheckConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check the boot loader configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root_dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string boot_dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.3. CheckInitrdModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check the specified initrd modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.4. CheckLoaderPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check boot loader packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string what

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.5. CheckSysconfigFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check the main config file for boot loader and kernel initrd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.6. ExistsConf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if the boot loader conf file exists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.7. InstallLoaderPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Install all missing package if the user accept.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string install_reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.8. InstallNewLoader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Install a new boot loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.9. PackageVersionStrings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return a list of strings with all required boot loader packages with the current and the required version.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string bootloader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.10. RepairConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Repair a damaged boot loader configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean show_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.11. RepairInitrdModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Wirte initrd modules and call mkinitrd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.12. RepairSysconfigFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Repairing configuration files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.13. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.14. VersionIsHigherOrEqual

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Compares the two specified version numbers. Each version number has to be a string of the form "21.6-34", "34.4.3", ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string version_1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string version_2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True if the first version number is newer than the second one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example 40. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   if (!OSRVersionIsHigherOrEqual("21.6", "22.3")) y2error("Something's wrong here.")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.15. repair_grub_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Repair a damaged grub configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.3.16. sectOptions2Map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reads specified section and returns values as list [$[option:$[value:..., comment:...]]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - map as described above

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4.1. boot_device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The boot device e.g.: /dev/hda1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4.2. missing_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of all not installed boot loader packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4.3. needed_config_files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configuration files needed by every boot loader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4.4. root_device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The root device e.g.: /dev/hda2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.4.5. root_mountpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The root mount point.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • BootCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Bootloader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Initrd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Kernel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRPkg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Product
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  178.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • repair/bootloader_routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Common functions and variables, used by other OSR modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Jiri Suchomel <jsuchome@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmptyList -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmptyListWithParam -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmptyMap -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EmptyString -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • False - Functions that could be used as a default in lookups for functin pointers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetGroupMap - Get group data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GlobalProvides - Set the new value of global_provides map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IsSubSet - Checks if the first specified list (of strings) is a subset of the second one. The sequence of entries in the lists is nonrelevant.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProvideBoolean - Stores the given boolean value with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProvideList - Stores the given list with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProvideMap - Stores the given map with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProvidePath - Stores the given path with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProvideString - Stores the given string with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RequireBoolean - Returns the required boolean value from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RequireList - Returns the required list from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RequireMap - Returns the required map from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RequirePath - Returns the required path from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RequireString - Returns the required string from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Reset - Reset variables moved from OSR.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SetGlobalProvides - Set the new value of global_provides map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SymbolError -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • current_detect_map - The current detection map during detection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • current_direct_name - The name of the current direct repair method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • current_module_name - The name of the current module during detection. e.g.: osr_module_partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • detect_group_list - ["init", "mbr_check", "swap_check", "fs_check", "fstab_check"]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • global_entries - $[ "fs_check" : $[ "help" : "Mounting a filesystem is not possible", "text" : "Check filesystem" ], "fstab_check" : $[ "help" : "Mounting a filesystem is not possible", "text" : "Check fstab entries" ], "init" : $[ "help" : "", "mode" : "forall", "text" : "Init repair system" ], "mbr_check" : $[ "help" : "If you have installed a other os after inst. Linux", "text" : "Check master boot record" ], ........ ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • tool_name - The name of the repair and rescue tool.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.1. EmptyList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - []

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.2. EmptyListWithParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list param

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - []

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.3. EmptyMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - $[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.4. EmptyString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.5. False

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Functions that could be used as a default in lookups for functin pointers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.6. GetGroupMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get group data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.7. GlobalProvides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the new value of global_provides map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.8. IsSubSet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Checks if the first specified list (of strings) is a subset of the second one. The sequence of entries in the lists is nonrelevant.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> l1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> l2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True if all elements of l1 are contained in l2 or if l1 is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example 41. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   OSRIsSubSet([], ["a", "b"]) -> true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   OSRIsSubSet(["a"], ["a", "b"]) -> true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   OSRIsSubSet(["c"], ["a", "b"]) -> false;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   OSRIsSubSet(["a", "b", "c"], ["a", "b"]) -> false;


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.9. ProvideBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stores the given boolean value with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.10. ProvideList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stores the given list with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.11. ProvideMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stores the given map with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.12. ProvidePath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stores the given path with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.13. ProvideString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stores the given string with the specified name into the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.14. RequireBoolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the required boolean value from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - value The required boolean value, false as default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.15. RequireList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the required list from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - The required list, [] as default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.16. RequireMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the required map from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - The required map, $[] as default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.17. RequirePath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the required path from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path - value The required path, . as default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.18. RequireString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the required string from the global_provides map in the osr_map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - value The required string, "" as default.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.19. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset variables moved from OSR.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.20. SetGlobalProvides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the new value of global_provides map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map new

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.3.21. SymbolError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol - `error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.1. current_detect_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current detection map during detection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.2. current_direct_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the current direct repair method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.3. current_module_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the current module during detection. e.g.: osr_module_partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.4. detect_group_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ["init", "mbr_check", "swap_check", "fs_check", "fstab_check"]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.5. global_entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $[ "fs_check" : $[ "help" : "Mounting a filesystem is not possible", "text" : "Check filesystem" ], "fstab_check" : $[ "help" : "Mounting a filesystem is not possible", "text" : "Check fstab entries" ], "init" : $[ "help" : "", "mode" : "forall", "text" : "Init repair system" ], "mbr_check" : $[ "help" : "If you have installed a other os after inst. Linux", "text" : "Check master boot record" ], ........ ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.4.6. tool_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the repair and rescue tool.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  179.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180. OSRDirect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Dialog and Execute of direct repair function. Repair Tool Box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddEntries - Add a new entry to the direct_methods map. Used in OSR module at the initial sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EvalDirectMethod - Eval the selected direct repair method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionMenu - Return a automatically generated menu for all direct repair methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Reset - Reset the module settings. Don`t reset direct_methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.3.1. AddEntries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add a new entry to the direct_methods map. Used in OSR module at the initial sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list new_entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.3.2. EvalDirectMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Eval the selected direct repair method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string method

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.3.3. OptionMenu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return a automatically generated menu for all direct repair methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • term

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.3.4. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset the module settings. Don`t reset direct_methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.4.1. mounted_root_partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Mounted root partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRFsck
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRFstab
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  180.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    181. OSRExecute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    181.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    181.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Command - Wrapper to CommandProgress, with the use of current log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CommandOutput - Executes the given commandline in a bash and writes all execution-information to the standard log file. This function returns all output from the commandline in a result map. Use these functions instead of directly calling the SCR or WFM agents (e.g. SCR::Execute(.target.bash_output, "rpm -q lilo") resp. WFM::(.local.bash_output, "rpm -q -r /mnt lilo")) to be sure to support logging correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CommandProgress - Executes the given commandline in a bash and writes all execution-information to the specified logfile. Use these functions instead of directly calling the SCR or WFM agents (e.g. SCR::Execute(.target.bash, "rpm -q lilo") resp. WFM::(.local.bash, "rpm -q -r /mnt lilo")) to be sure to support logging correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.3.1. Command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Wrapper to CommandProgress, with the use of current log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string commandline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.3.2. CommandOutput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Executes the given commandline in a bash and writes all execution-information to the standard log file. This function returns all output from the commandline in a result map. Use these functions instead of directly calling the SCR or WFM agents (e.g. SCR::Execute(.target.bash_output, "rpm -q lilo") resp. WFM::(.local.bash_output, "rpm -q -r /mnt lilo")) to be sure to support logging correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string commandline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.3.3. CommandProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Executes the given commandline in a bash and writes all execution-information to the specified logfile. Use these functions instead of directly calling the SCR or WFM agents (e.g. SCR::Execute(.target.bash, "rpm -q lilo") resp. WFM::(.local.bash, "rpm -q -r /mnt lilo")) to be sure to support logging correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • path environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string commandline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string progress_file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - Success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 42. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	OSRExecute::CommandProgress (.local.bash, "rpm -qi -r /mnt/ lilo",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"/tmp/progress_file");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         $ cat /tmp/osr.log
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         *** /bin/rpm -qi lilo ***
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Name      : lilo         Relocations: (not relocateable)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Version   : 21.6              Vendor: SuSE GmbH, Nuernberg, Germany
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         [...]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         SuSE series: a
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         *** exit code: 0 ***


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      181.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182. OSRFloppy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        How to use OSRFloppy module: 1. OSRFloppy::Open( with ui support, count of files to read/wirte ); 2. optional: OSRFloppy::NextStep(_(Copy the file .. )); WFM::Execute(.local.bash, "/bin/cp ... "); or OSRFloppy::ReadMap( .. ) or OSRFloppy::SaveMap( .. ) 3. OSRFloppy::Close();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Close - Close Floppy Dialog and unmount floppy device. You must call OSRFloppy::Open(.. ) before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NextStep - Change the text in the floppy dialog and increase the progress bar. If not dialog is opened, write the test to the YaST2 log file (y2log).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Open - Open floppy for IO. Afterwards you must call OSRFloppy::Close().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.3.1. Close

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Close Floppy Dialog and unmount floppy device. You must call OSRFloppy::Open(.. ) before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.3.2. NextStep

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Change the text in the floppy dialog and increase the progress bar. If not dialog is opened, write the test to the YaST2 log file (y2log).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.3.3. Open

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Open floppy for IO. Afterwards you must call OSRFloppy::Close().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean use_ui

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer count_io_files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.4.1. floppy_device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default floppy device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.4.2. mount_point

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default mount point

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StorageDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        182.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183. OSRFsck

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          YaST OS Repair. Automatic error detection &amp; repair tool for Linux.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Check - Test the filesystem of one partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsNonLinuxFileSystem - checks for filesystem type (Repair module should not touch non-linux partitions - bug #25002)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • LoadAllFsModules - Load all needed fileystem and lvm/raid modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRFsck - Constructor. Fill the list fsck_fsid with the date from module Partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PossiblePartitions - Return a list witch contains all partitions names that can be used for a fsck.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Repair - The main repair dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.1. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Test the filesystem of one partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map part

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.2. IsNonLinuxFileSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          checks for filesystem type (Repair module should not touch non-linux partitions - bug #25002)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol fs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.3. LoadAllFsModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Load all needed fileystem and lvm/raid modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.4. OSRFsck

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructor. Fill the list fsck_fsid with the date from module Partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.5. PossiblePartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return a list witch contains all partitions names that can be used for a fsck.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.3.6. Repair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The main repair dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string t_check_partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol used_fs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol - `ok,`error,`cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.4.1. fs_kernel_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The loaded modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.4.2. fsck_fsid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A list of all possible filesystem id's for fsck...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.4.3. fsck_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A list of all possible types for a fsck ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.4.4. not_installed_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The not loaded filesystem an lvm/raid modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          183.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184. OSRFstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            YaST OS Repair. Automatic error detection &amp; repair tool for Linux.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Use:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::LinuxPartitions ("/dev/hda1", "/dev/hda2", .. ]);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::MountablePartitions( ..);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::ValidRootPartitions( ..);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::ReadFstab("/");

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::CheckRootEntry ("/dev/hda1",

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ["/dev/hda2"], ["/dev/hda3", "/dev/hda4" ]);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::Repair();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::Check(["/dev/hda2"], ["/dev/hda3", "/dev/hda4" ]);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFstab::Repair();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.1. BootDev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.2. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check if all entries in the fstab are valid and if all found devices have an entry in the fstab.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> tswapable_partition_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> tchecked_partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> tencrypted_partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.3. CheckRootEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string dev_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> tswapable_partition_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> tchecked_partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.4. LinuxPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find the list of all valid linux-partitions in the target-map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list checked_partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - The list of names of valid linux-partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.5. MountAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mount all partitions specified in the fstab. If no fstab was readed try to find root partition and read fstab. Afterwards mount all partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.6. MountablePartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a list of names of all mountable partitions out of the specified list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> linux_partition_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string m_point

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - List of partition names successfully mounted to m_point.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.7. OSRFstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructor: initialize data structures with default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.8. ReadFstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read the fstab file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mount_p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean strict

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.9. ReadSuccessfully

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            /etc/fstab was read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.10. Repair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Repair the fstab. Call sub dialogs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.11. RootDev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.12. SelectRoot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ask user to select the root partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> valid_root_partition_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.13. UmountAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> umount_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.14. UmountAllFrom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.15. ValidRootPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a list of names of all mountable partitions that contain a file /etc/fstab out of the specified list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> mount_possible_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mount_p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - The list of partition-names that were successfully mounted to /mnt and contain a filesystem table.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.16. check_and_create_mount_points

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map cmp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - create failed for mount points $[ 1 : "/hhh" ];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.3.17. partition_mounted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check if given partition is already mounted workaround; this should be done via Storage API (bnc#372238)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string part

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.4.1. fstabpath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Hotplug
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Initrd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRFsck
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OSRSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SuSERelease

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            184.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              185. OSRLogFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              YaST2 OS Repair. Automatic error detection &amp; repair tool for Linux.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              185.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Michael Koehrmann <curry@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              185.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Add - Writes the specified string to the end of the log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetLogFileName - This function returns the name of the global log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetTmpDir - Returns the path of the global temporary directory, e.g. "/tmp/YaST2-02274".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRLogFile - Constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Writes the specified string to the end of the log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string the_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True if the specified string was successfully written

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.3.2. GetLogFileName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This function returns the name of the global log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - The name of the global log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.3.3. GetTmpDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the path of the global temporary directory, e.g. "/tmp/YaST2-02274".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - The path of the temporary directory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example 43. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 string tmpdir = GetTmpDir();


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.3.4. OSRLogFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                185.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186. OSRMode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Special OSR mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • IsValid - Get the execution-mode, description: Stage::initial () == true -> Initial boot per CD-Rom or NFS Stage::cont () == true -> Continue installation Stage::initial ()e == false) &amp;&amp; (Stage::cont () == false) -> Running Linux-system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • automatic - Automatic detection and repair, no user-interaction but GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • demo - No real error-detection or repair, only demonstration, GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • detection - Only detection, no repair, GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • provides - Prints the values provided by the detection-modules to the

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • script - No GUI, no user-interaction, input-values come from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.3.1. IsValid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the execution-mode, description: Stage::initial () == true -> Initial boot per CD-Rom or NFS Stage::cont () == true -> Continue installation Stage::initial ()e == false) &amp;&amp; (Stage::cont () == false) -> Running Linux-system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4.1. automatic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Automatic detection and repair, no user-interaction but GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4.2. demo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                No real error-detection or repair, only demonstration, GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4.3. detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Only detection, no repair, GUI.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4.4. provides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Prints the values provided by the detection-modules to the

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.4.5. script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                No GUI, no user-interaction, input-values come from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                186.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  187. OSRModuleLoading

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Load and unload kernel modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  187.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  187.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Load - Load a module if not already loaded by linuxrc and saves the name of the loaded modules in the list loaded_modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRModuleLoading - The constructor init the startup_loaded_modules list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Unload - Unload one kernel module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • UnloadAll - Unload all loaded kernel modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.3.1. Load

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Load a module if not already loaded by linuxrc and saves the name of the loaded modules in the list loaded_modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string modulename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string moduleargs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string vendorname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string devicename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean ask_before_loading

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean with_modprobe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - : `dont user choose *not* to load module `ok module loaded ok `fail module loading failed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.3.2. OSRModuleLoading

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The constructor init the startup_loaded_modules list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.3.3. Unload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Unload one kernel module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.3.4. UnloadAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Unload all loaded kernel modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ModuleLoading

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    187.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188. OSRPkg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Packages check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CheckDB - Return false if db files are missing. Save missing files in the list not_found_files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CheckMinimum - Check if all minimal required packages are installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CheckProductVersions - Check if target product is the same as the source (bug #45306)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • InstallMissing - Install selected Packages. The packages are damaged or not install. Call CheckMinimum or VerifyPackages before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRPkg - Constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OpenPkg - Open the package database.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RepairDB - Repair or initialise a damaged package damaged. Call CheckDB before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Reset - Reset the module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • VerifyPackages - Verify all specified packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.1. CheckDB

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return false if db files are missing. Save missing files in the list not_found_files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.2. CheckMinimum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if all minimal required packages are installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.3. CheckProductVersions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if target product is the same as the source (bug #45306)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if product are the same

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.4. InstallMissing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Install selected Packages. The packages are damaged or not install. Call CheckMinimum or VerifyPackages before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean use_dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.5. OSRPkg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.6. OpenPkg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Open the package database.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.7. RepairDB

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Repair or initialise a damaged package damaged. Call CheckDB before.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.8. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reset the module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.3.9. VerifyPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Verify all specified packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string what

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean expert_mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.1. error_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Error text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.2. help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Help text to show errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.3. install_missing_dialog_data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Dialog description for the install missing or damaged packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.4. missing_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Not installed base packages or damaged packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.5. not_found_files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Missing packages database files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.4.6. root_mountpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Mount point where the target system is mounted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • DefaultDesktop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRPkgUI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRPkgVerify
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      188.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189. OSRPkgUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Packages check UI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • EvalUserInput - Eval the user input.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Finish - Finish the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRPkgUI - Constructor- reset module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OpenVerifyDialog - Open the main dialog depending on the values t_expert_mode (expert_mode).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProtocolDialog - Show the detailed list of packages that failed to be verified, together with rpm -V output. User can review the errors and choose the packages to reinstall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Reset - Reset all (not static) module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • update_missing_packages - update the item list of 'missing_packages' with the ones selected to reinstall by user during verification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.1. EvalUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Eval the user input.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.2. Finish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Finish the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.3. OSRPkgUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructor- reset module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.4. OpenVerifyDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Open the main dialog depending on the values t_expert_mode (expert_mode).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer size_progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean t_expert_mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.5. ProtocolDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show the detailed list of packages that failed to be verified, together with rpm -V output. User can review the errors and choose the packages to reinstall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - packages that are selected for reinstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.6. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reset all (not static) module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.3.7. update_missing_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        update the item list of 'missing_packages' with the ones selected to reinstall by user during verification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<list> item_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<list>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.4.1. expert_mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If expert is activated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRPkgVerify
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRProgress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        189.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190. OSRPkgVerify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Packages check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • initial_verified_packages - Verified packages after a new installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max_files - maximum of file entries shown in detailed pkg verification summary (necessary because of potential large memory requirements)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • missing - Missing key. For parsing rpm output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • separator - Key seperate packagename with not valid file count.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • unsatisfied - Unsatisfied key. For parsing rpm output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3.1. GreenPackageProblems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return if a package was not build correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map pkg_data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3.2. OSRPkgVerify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          module constructor: read packages with build problems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3.3. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3.4. Verify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string p

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string root_mountpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.3.5. WriteVerifiedPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Debug the verified packages informations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean debug

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4.1. initial_verified_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Verified packages after a new installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4.2. max_files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maximum of file entries shown in detailed pkg verification summary (necessary because of potential large memory requirements)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4.3. missing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Missing key. For parsing rpm output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4.4. separator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Key seperate packagename with not valid file count.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.4.5. unsatisfied

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Unsatisfied key. For parsing rpm output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OSRMode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          190.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            191. OSRPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            191.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            191.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ChangeFieldDialog - Dialog to change one field in the fstab.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • MultiSelectionBox - A dialog with to messages and a multi selection box in the center.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OpenMainRepairDialog - Open a dialog with the term r_options in the center.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OpenSuggestDialog - Open the base dialog to suggest modify.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RadioButtonGroup - This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified default is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RadioButtonGroupText - This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified cancel-value is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Repair - This method opens a new popup window that displays the error message. It provides a repair button, a skip button and a help button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • build_label_description - Build (return) a description text for a label in the help_text field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.1. ChangeFieldDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Dialog to change one field in the fstab.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string org_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.2. MultiSelectionBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A dialog with to messages and a multi selection box in the center.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message_top

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message_bottom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string box_headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<list> item_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<list> special_buttons_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.3. OpenMainRepairDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Open a dialog with the term r_options in the center.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string error_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • term r_options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.4. OpenSuggestDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Open the base dialog to suggest modify.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • term body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer hweight

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.5. RadioButtonGroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified default is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> item_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string default_val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean strict

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - The selected item, the default if cancel is pressed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 44. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               string result = OSRPopup::RadioButtonGroup("Test", "This is just a test.", ["a", "b", "c"], "b", true);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.6. RadioButtonGroupText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This method opens a popup window that offers the specified items to the user. The items can be selected in a RadioButtonGroup. A default item has to be specified. It is marked as selected from start. If the default is "", the first item in the list is marked as selected. It provides an OK button and a Cancel button. If OK is pressed the selected item is returned as a string, if cancel is pressed, the specified cancel-value is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<list> item_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string default_val

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean strict

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - The selected item, the default if cancel is pressed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 45. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               string result = OSRPopup::RadioButtonGroupText("Test",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "This is a test.",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              						      [["a" , "First choice"], ["b", "Second choice"]],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              						      "b",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              						      "cancel",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              						      true); 


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.7. Repair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This method opens a new popup window that displays the error message. It provides a repair button, a skip button and a help button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the repair button was pressed by the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 46. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               boolean repair_question = OSRPopup::Repair( "Error detected", error_message, help_text);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.3.8. build_label_description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Build (return) a description text for a label in the help_text field.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - the formatted label help text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              191.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192. OSRProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Create - Create a new Progress Widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DeleteFile - Only for DownloadProgress !! Delete the progress file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Fill - Fills the global-progress-bar with 100%.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Increase - This method is called after one detection function is successfully executed. It shows the continuous progress to the user with the global progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Reset - Reset module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetFile - Specifies a new filename for the DownloadProgress widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetLabel - Set the label of a progress-bar to the specified one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetLength - Set the length of a progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetSteps - Set the Steps of a normal ProgressBar Widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • length - The length of a ProgressBar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.1. Create

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a new Progress Widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean downloadprogress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • term

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.2. DeleteFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Only for DownloadProgress !! Delete the progress file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.3. Fill

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fills the global-progress-bar with 100%.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True if the progress value was increased successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.4. Increase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This method is called after one detection function is successfully executed. It shows the continuous progress to the user with the global progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True if the progress value was increased successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.5. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Reset module settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.6. SetFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Specifies a new filename for the DownloadProgress widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string new_file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example 47. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 OSRModuleProgress::SetFile("/tmp/YaST2-823/osr_lilo_progress");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.7. SetLabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the label of a progress-bar to the specified one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string new_label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - boolen True if the label was set correctly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.8. SetLength

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the length of a progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer new_length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.3.9. SetSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the Steps of a normal ProgressBar Widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.4.1. length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The length of a ProgressBar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                192.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  193. OSRPtbl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  YaST OS Repair. Automatic error detection &amp; repair tool for Linux.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  193.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  193.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.3.1. MainPtblRepairDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Main Dialog for repairing deleted/not valid partition tables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string t_target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.3.2. RestoreWithGpart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restoring a partition tables with gpart.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.3.3. WritePartitionsInfo2Floppy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write partition info of given disk to floppy (needs mounted floppy)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list parts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OSRFloppy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    193.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      194. OSRRepairUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UI functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      194.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      194.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.3.1. InitDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Init Dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.3.2. OSRRepairUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.3.3. OsrMainDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Main dialog. Manage the sequence of the different dialogs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.3.4. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reset api modules for the next scan and repair sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Hotplug
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSR
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRDirect
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRProgress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OSRSummary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageCallbacksInit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Sequencer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StorageControllers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        194.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          195. OSRStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          195.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Johannes Buchhold <jbuch@suse.de>, 2002

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          195.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectError - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectError2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectOK - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectOK2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectOmit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectProblem - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectProblem2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ErrorSeverityBlocking - Sets the level of severity of the detected error. API function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ErrorSeverityModuleBlocking - Sets the level of severity of the detected error. API function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Exit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsErrorSeverityBlocking - Returns the level of severity of the detected error. This severity involves the rescue system to stop the further execution if the detected error is not repaired. E.g. if the rescue system does not detect any harddisks it makes no sense to go on checking for any errors. The rescue system will halt.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsErrorSeverityModuleBlocking - Returns the level of severity of the detected error. This severity means that the detected error involves to jump to the next detection module without executing any further method of the current module. E.g. if the rescue system detects that the LILO package is not installed on the system and this error could not be repaired, it makes no sense to check the LILO configuration file for any errors. So the rescue system jumps to the next module in the module sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusDetectError - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusDetectOK - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusDetectOmit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusDetectProblem - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusExit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusRepairError - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusRepairOK - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsStatusRepairOmit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • NotFound2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairError - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairError2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairOK - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairOK2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairOmit - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RepairOmit2Name - This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.1. DetectError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.2. DetectError2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.3. DetectOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.4. DetectOK2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.5. DetectOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.6. DetectProblem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.7. DetectProblem2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.8. ErrorSeverityBlocking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the level of severity of the detected error. API function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void - The severity of the detected error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.9. ErrorSeverityModuleBlocking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the level of severity of the detected error. API function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void - The severity of the detected error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.10. Exit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.11. IsErrorSeverityBlocking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the level of severity of the detected error. This severity involves the rescue system to stop the further execution if the detected error is not repaired. E.g. if the rescue system does not detect any harddisks it makes no sense to go on checking for any errors. The rescue system will halt.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - The severity of the detected error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.12. IsErrorSeverityModuleBlocking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the level of severity of the detected error. This severity means that the detected error involves to jump to the next detection module without executing any further method of the current module. E.g. if the rescue system detects that the LILO package is not installed on the system and this error could not be repaired, it makes no sense to check the LILO configuration file for any errors. So the rescue system jumps to the next module in the module sequence.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - The severity of the detected error.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.13. IsStatusDetectError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Is error?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.14. IsStatusDetectOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Is OK?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.15. IsStatusDetectOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Omitted?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.16. IsStatusDetectProblem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Is detect problem?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.17. IsStatusExit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.18. IsStatusRepairError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Repair failed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.19. IsStatusRepairOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Repaired?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.20. IsStatusRepairOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Repait omitted?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.21. NotFound2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.22. RepairError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.23. RepairError2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.24. RepairOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.25. RepairOK2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.26. RepairOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.3.27. RepairOmit2Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This function is a wrapper for the definition of the correct status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tnext_detect_method_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            195.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            196. OSRSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            196.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Johannes Buchhold <jbuch@suse.de>, 2002

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Create a unified-looking RichText description of the not configured/configured devices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • This is used in <module_name>_summary.ycp modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            196.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectError - Changes the summary of the specified module in the RichText widget. Shows that the rescue system has detected an error. Red font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectOK - Changes the summary of the specified module in the RichText widget. Shows that the rescue system has found no error. Blue font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectOmit - Changes the summary of the specified module in the RichText widget. Shows that the rescue system has found no error. Blue font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectProblem - Changes the summary of the specified module in the RichText widget. Shows that the rescue system has detected a potential problem. Red font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RepairError - Changes the summary of the specified module in the RichText widget. Shows that an error occurred during the repair-process. ??? font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RepairOK - Changes the summary of the specified module in the RichText widget. Shows that the rescue system repaired the detected error. ??? font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RepairOmit - Changes the summary of the specified module in the RichText widget. Shows that the repair process was omitted by the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Update - Updates the contents of the RichText widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.1. DetectError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the rescue system has detected an error. Red font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.2. DetectOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the rescue system has found no error. Blue font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.3. DetectOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the rescue system has found no error. Blue font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.4. DetectProblem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the rescue system has detected a potential problem. Red font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.5. RepairError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that an error occurred during the repair-process. ??? font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.6. RepairOK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the rescue system repaired the detected error. ??? font is used for the headline.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.7. RepairOmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Changes the summary of the specified module in the RichText widget. Shows that the repair process was omitted by the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was updated successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.3.8. Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Updates the contents of the RichText widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the RichText widget was changed successfully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRCommon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRLogFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRProgress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OSRStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              196.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                197. OSRSwap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                YaST OS Repair. Automatic error detection &amp; repair tool for Linux.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                197.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                197.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Partitions - Get all valid swap-partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Repair - Create swap area on a swap partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ValidPartitions - Returns a list of names (e.g. ["/dev/hda1", "/dev/hdb3"]) of all partitions that can be mounted to the system as swap out of the specified list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.3.1. Partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get all valid swap-partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - The list of valid swap-partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.3.2. Repair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create swap area on a swap partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.3.3. ValidPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns a list of names (e.g. ["/dev/hda1", "/dev/hdb3"]) of all partitions that can be mounted to the system as swap out of the specified list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> partition_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - The list of partition names that were successfully added to the system as swap partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRExecute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OSRPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  197.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    198. OSRSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    198.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Johannes Buchhold <jbuch@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    198.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.3.1. ChangeRoot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Change the root environment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string new_root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.3.2. SetTargetRoot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Change root to target root mount point.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OSRStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      198.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        199. OneClickInstall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        199.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          199.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.1. FromXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DeSerialises this data structure from XML.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.2. GetDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the description for this software bundle. This will be in the user's current language if there was a localised description available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.3. GetName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the name for this software bundle.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.4. GetNonRequiredRemoveSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the names of the software currently selected for removal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.5. GetNonRequiredRepositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the URLs of the repositories currently NOT selected for addition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.6. GetNonRequiredSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the names of the software currently NOT selected for installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.7. GetRemainSubscribed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - the current setting of whether the user should remain subscribed to repositories after installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.8. GetRepositoryDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the description of the repository with the specified name. This will be in the user's current language if there was a localised description available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.9. GetRepositoryName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the name of the repository with the specified name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.10. GetRepositorySummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the summary of the repository with the specified name. This will be in the user's current language if there was a localised summary available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.11. GetRequiredRemoveSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the names of the software currently selected for removal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.12. GetRequiredRepositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the URLs of the repositories currently selected for addition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.13. GetRequiredSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - a list of the names of the software currently selected for installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.14. GetSoftwareDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the description for the software with specified name. This will be in the user's current language if there was a localised description available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.15. GetSoftwareSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the summary for the software with specified name. This will be in the user's current language if there was a localised summary available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.16. GetSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the summary for this software bundle. This will be in the user's current language if there was a localised summary available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.17. HaveAnyRecommended

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Whether we have any recommended repositories or packages If not we will have to show advanced view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.18. HaveAnythingToDo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Whether we have anything to do Determine whether we have a proper metapackage, useful as we can't throw exceptions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.19. HaveBundleDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Whether we have a bundle description for the whole bundle Build service isn't currently generating one for YMPs for individual packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.20. HaveRemovals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Find out whether we have any software that needs to be removed for this installation. Useful to find out whether to display this wizard step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.21. HaveRepositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Find out whether we have any repositories that need to be added for this installation. Useful to find out whether to display this wizard step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.22. HaveSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - Find out whether we have any software that needs to be installed for this installation. Useful to find out whether to display this wizard step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.23. Load

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Load the Metapackage from the URL supplied for further processing. Converts from original form into a simple two lists, one of repositories, other of software. Uses the Product.ycp to obtain the correct version for our product. Uses the Language.ycp to obtain correct strings for our language.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.24. SetNonRequiredRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures that the repository with the specified URL is NOT selected for addition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.25. SetNonRequiredSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures the software with the specified name is NOT selected for installation or removal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.26. SetRemainSubscribed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Specify whether the user should remain subscribed to the repositories after installation of this software is complete.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.27. SetRequiredRepositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures that the repositories with specified URLs are selected for addition, and all others are not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> urls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.28. SetRequiredRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures that the repository with the specified URL is selected for addition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.29. SetRequiredSoftware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures the software with the specified name is selected for installation or removal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.30. SetRequiredSoftwares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Ensures that the repositories with specified URLs are selected for addition, and all others are not. Invalid pluralisation due to lack of proper overloading :(

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.3.31. ToXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Serialises this data structure to XML.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Product
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • XML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • YPX

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            199.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              200. OneClickInstallStandard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Module for parsing One Click Install Standard http://en.opensuse.org/Standards/One_Click_Install

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              200.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              200.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetRepositoriesFromXML - Converts XML file to a list of maps with all repositories described in the XML content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.3.1. GetRepositoriesFromXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Converts XML file to a list of maps with all repositories described in the XML content.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <map <string, any> > - <map, <string, any> >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "distversion" : "openSUSE Factory",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "url" : "full url of the repository (http://.../)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "format" : "yast",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "recommended" : true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "description" : "repository description",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "localized_description" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "en_GB" : "repository description (localized to en_GB)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "summary" : "repository summary",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "localized_summary" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "en_GB" : "repository summary (localized to en_GB)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "name" : "repository name",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "localized_name" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "en_GB" : "repository name (localized to en_GB)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                200.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  201. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  201.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    201.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        201.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        201.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        201.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        201.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        201.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          202. OneClickInstallWorkerFunctions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          202.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            202.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AddRepositories - * Subscribe to all the specified repositories * return true if all catalogues were added successfully, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DeDupe - * Check whether this repository is already subscribed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • InstallPackages - * Install all the specified packages * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • InstallPatterns - * Install all the specified patterns * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemovePackages - * Remove all the specified packages * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3.1. AddRepositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              * Subscribe to all the specified repositories * return true if all catalogues were added successfully, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> repositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3.2. DeDupe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              * Check whether this repository is already subscribed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> url_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3.3. InstallPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              * Install all the specified packages * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3.4. InstallPatterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              * Install all the specified patterns * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.3.5. RemovePackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              * Remove all the specified packages * return true if all installations were successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OneClickInstall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OneClickInstallWorkerResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SourceManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              202.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • packager/inst_source_dialogs.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              203. OneClickInstallWorkerResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              203.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                203.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.1. FromXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DeSerialises this data structure from XML.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.2. GetErrorMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - the error message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.3. GetFailureStage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - the string representation of the failure stage of the install process.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.4. GetNote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - the note.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.5. GetSuccess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - the success indicator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.6. SetErrorMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.7. SetFailureStage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.8. SetNote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.9. SetSuccess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.3.10. ToXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Serialises this data structure to XML.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  203.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    204. OnlineUpdate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data used for Online Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    204.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stefan Schubert <schubi@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    204.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cd_directory - Default Patch CD source directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cd_update - flag: do we do an update from CD?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cd_url - Default URL for Patch CD source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • simple_mode - If simple Package selector should be opened

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.4.1. cd_directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default Patch CD source directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.4.2. cd_update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flag: do we do an update from CD?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.4.3. cd_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default URL for Patch CD source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.4.4. simple_mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If simple Package selector should be opened

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      204.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      205. OnlineUpdateCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      205.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Cornelius Schumacher <cschum@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Purpose: provides the Callbacks for the online update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      205.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.1. DonePackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for 'package installed' action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.2. DoneProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for 'package provided' action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.3. FinishLine

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Callback for finishing an action in the log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.4. PatchProgressCallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Callback for patch (resp. delta rpm) progress widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.5. ProblemDeltaApply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for problem during aplying delta

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.6. ProblemDeltaDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for problem during downloading delta

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.7. ProblemPatchDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for problem during aplying delta

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.8. ProgressDeltaApply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        progress of applying delta (cannot be aborted)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.9. ProgressDeltaDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for delta download progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - abort the download?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.10. ProgressLog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        add a text to the installation progress log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.11. ProgressPatchDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for path download progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - abort the download?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.12. RefreshSources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Refresh sources given by argument

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map> sources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.13. RegisterOnlineUpdateCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.14. StartDeltaDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for start of delta download

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer download_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.15. StartPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Callback for starting installation of a package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer installsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean is_delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.16. StartPatchDownload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback for start of downloading patch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer download_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.3.17. StartProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Callback for starting download of a package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer archivesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OnlineUpdateDialogs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        205.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          206. OnlineUpdateConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Registration related stuff

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          206.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • J. Daniel Schmidt <jdsn@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          206.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - AutoYaST interface function: Export()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AutoYaST interface function: Export()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - with the settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            206.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              207. OnlineUpdateDialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              YOU dialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              207.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Cornelius Schumacher <cschum@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              207.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  207.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  207.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  207.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  207.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  207.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    208. Package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Packages manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    208.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    208.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.3.1. DoInstall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Install list of packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.3.2. DoInstallAndRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Install and Remove list of packages in one go

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> toinstall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> toremove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.3.3. DoRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove list of packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageAI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      208.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • packages/common.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      209. PackageAI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Packages manipulation (autoinstallation)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      209.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      209.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageAvailable - Is a package available? Checks only package name, not list of provides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageInstalled - Is a package installed? Checks only the package name in contrast to Installed() function.

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.3.1. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.3.2. PackageAvailable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Is a package available? Checks only package name, not list of provides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.3.3. PackageInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Is a package installed? Checks only the package name in contrast to Installed() function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.3.4. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        209.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          209.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • packages/common.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          210. PackageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          210.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Purpose: provides the default Callbacks for Pkg::

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          210.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.1. DonePackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            After package install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.2. DoneScanDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Callback for finish RPM DB scan event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.3. EnableAsterixPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enable or disable StartPackage, ProgressPackage and DonePackage callbacks, but only the progress bar and not the final error message. Returns old value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean f

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.4. ErrorScanDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Callback for error handling during RPM DB scan

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.5. InitPackageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Register package manager callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.6. PackageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.7. ProcessDone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hander for ProcessDone callback - the process has been finished

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.8. ProcessNextStage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hander for ProcessNextStage callback - the current stage has been finished

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.9. ProcessProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hander for ProcessProgress callback - report total progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.10. ProcessStart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hanler for ProcessStart callback - handle start of a package manager process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string task

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> stages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string help

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.11. ProgressPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            During package install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.12. ProgressScanDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Callback for RPM DB scan progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.13. SetMediaCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Register callbacks for media change

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.14. SourceChange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dummy repository change callback, see SlideShowCallbacks for the real one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer medianr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.15. StartPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            At start of package install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer installsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean is_delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.3.16. StartScanDb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Callback for start RPM DB scan event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Icon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SignatureCheckCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            210.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              211. PackageCallbacksInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Initialize packager callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              211.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              211.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.3.1. InitPackageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Register package manager callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • PackageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                211.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  212. PackageInstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  212.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  212.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • CommitPackages - commitPackages marked for deletion or installation Return: [ int successful, list failed, list remaining, list srcremaining ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.3.1. CommitPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    commitPackages marked for deletion or installation Return: [ int successful, list failed, list remaining, list srcremaining ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer media_number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer packages_installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • PackageSlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SlideShow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    212.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      213. PackageLock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Packages manipulation (system)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      213.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      213.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check - Tries to acquire the packager (zypp) lock. Reports an error if another process has the lock already. Will only report once even if called multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Connect - Tries to acquire the packager (zypp) lock. Reports an error if another process has the lock already. Will only report once even if called multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.3.1. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tries to acquire the packager (zypp) lock. Reports an error if another process has the lock already. Will only report once even if called multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if we can continue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.3.2. Connect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tries to acquire the packager (zypp) lock. Reports an error if another process has the lock already. Will only report once even if called multiple times.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean show_continue_button

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any> - true if we can continue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        213.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          214. PackageSlideShow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          214.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          214.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • InitPkgData - Initialize internal pacakge data, such as remaining package sizes and times. This may not be called before the pkginfo server is up and running, so this cannot be reliably done from the constructor in all cases.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetCurrentCdNo - Set the current repository and CD number. Must be called for each CD change. src_no: 1...n cd_no: 1...n

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetMediaType - set media type "CD" or "DVD"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SlideDisplayDone - package start display update - this is called at the end of a new package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SlideDisplayStart - package start display update - this is called at the beginning of a new package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SlideProvideStart - Package providal start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • StripPath - Get package file name from path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • StripReleaseNo - Get version info for a package (without build no.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • UpdateAllCdProgress - Update progress widgets for all CDs. Uses global statistics variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • UpdateCurrentCdProgress - Update progress widgets for the current CD: Label and ProgressBar. Use global statistics variables for that.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • UpdateCurrentPackageProgress - Progress display update This is called via the packager's progress callbacks.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.1. InitPkgData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Initialize internal pacakge data, such as remaining package sizes and times. This may not be called before the pkginfo server is up and running, so this cannot be reliably done from the constructor in all cases.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.2. SetCurrentCdNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the current repository and CD number. Must be called for each CD change. src_no: 1...n cd_no: 1...n

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer src_no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer cd_no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.3. SetMediaType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            set media type "CD" or "DVD"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string new_media_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.4. SlideDisplayDone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            package start display update - this is called at the end of a new package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer pkg_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean deleting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.5. SlideDisplayStart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            package start display update - this is called at the beginning of a new package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer pkg_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean deleting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.6. SlideProvideStart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Package providal start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer sz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.7. StripPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get package file name from path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - package file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.8. StripReleaseNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get version info for a package (without build no.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - version string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.9. UpdateAllCdProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update progress widgets for all CDs. Uses global statistics variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean silent_check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.10. UpdateCurrentCdProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update progress widgets for the current CD: Label and ProgressBar. Use global statistics variables for that.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean silent_check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.3.11. UpdateCurrentPackageProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Progress display update This is called via the packager's progress callbacks.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer pkg_percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Slides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            214.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              215. PackageSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Packages manipulation (system)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              215.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              215.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.1. Available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is a package available?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if yes (nil = no package source available)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.2. CheckAndInstallPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Check if packages are installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if installation succeeded or packages were installed, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.3. CheckAndInstallPackagesInteractive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Check if packages are installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if installation succeeded, packages were installed before or user decided to continue, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.4. EnsureSourceInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Ensure that Pkg:: calls working with the installation sources work

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.5. EnsureTargetInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Ensure that Pkg:: calls work. This may become superfluous.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.6. Installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is a package provided in the system? Is there any installed package providing 'package'?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.7. PackageAvailable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is a package available? Checks only package name, not list of provides.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if yes (nil = no package source available)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.3.8. PackageInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is a package installed? Checks only the package name in contrast to Installed() function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • PackageLock
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                215.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • packages/common.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                216. Packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                216.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                216.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CheckContentFile - Check whether content file in the specified repository is the same as the one in the ramdisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CheckDiskSize - Check if selected software fits on the partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CheckOldAddOns - Checks which products have been selected for removal and modifies the warning messages accordingly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ComputeSystemPackageList - Build and return list of packages which depends on the the current target system and the preselected packages (architecture, X11....)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CountSizeToBeDownloaded - Count the total size of packages to be installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CountSizeToBeInstalled - Count the total size of packages to be installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetBaseSourceID - Returns ID of the base product repository.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InfoAboutSubOptimalDistribution - Return information about suboptimal distribution if relevant

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Initialize - Initialize the repositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InitializeAddOnProducts - Initialize add-on products provided by the repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InitializeCatalogs - Initialize the repositories with popup feedback Use Packages::Initialize (true) instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ListSelected - List selected resolvables of specified kind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Proposal - Make a proposal for package selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Reset - Reset package selection, but keep objects of specified type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SelectProduct - Select the base product on the media for installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary - Print the installatino proposal summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SummaryOutput - Return the summary output lines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • addAdditionalPackage - Add a package to list to be selected before proposal Can be called only before the installation proposal, later doesn't have any effect. OBSOLETE! Please, use PackagesProposal::AddResolvables() instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.1. CheckContentFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check whether content file in the specified repository is the same as the one in the ramdisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if content files match

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.2. CheckDiskSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if selected software fits on the partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if selected software fits, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.3. CheckOldAddOns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Checks which products have been selected for removal and modifies the warning messages accordingly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map & ret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.4. ComputeSystemPackageList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Build and return list of packages which depends on the the current target system and the preselected packages (architecture, X11....)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.5. CountSizeToBeDownloaded

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Count the total size of packages to be installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer - size of packages to be installed (in bytes)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.6. CountSizeToBeInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Count the total size of packages to be installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - formatted size of packages to be installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.7. GetBaseSourceID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ID of the base product repository.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer - base source ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.8. InfoAboutSubOptimalDistribution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return information about suboptimal distribution if relevant

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - the information string or empty string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.9. Initialize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize the repositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean show_popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.10. InitializeAddOnProducts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize add-on products provided by the repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.11. InitializeCatalogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize the repositories with popup feedback Use Packages::Initialize (true) instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.12. ListSelected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List selected resolvables of specified kind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol what

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string format

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - a list of selected resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.13. Proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Make a proposal for package selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean force_reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean reinit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean simple

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - for the API proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.14. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset package selection, but keep objects of specified type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<symbol> keep

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.15. SelectProduct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Select the base product on the media for installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.16. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Print the installatino proposal summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<symbol> flags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean use_cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.17. SummaryOutput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the summary output lines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<symbol> flags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string> - a list of the output lines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.3.18. addAdditionalPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add a package to list to be selected before proposal Can be called only before the installation proposal, later doesn't have any effect. OBSOLETE! Please, use PackagesProposal::AddResolvables() instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddOnProduct
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • DefaultDesktop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • InstURL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Kernel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • PackagesProposal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Product
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Slides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SourceDialogs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SpaceCalculation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • WorkflowManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  216.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • packager/load_release_notes.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  217. PackagesProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  API for selecting or de-selecting packages for installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  217.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  217.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddResolvables - Adds list of resolvables to pool that is then used by software proposal to propose a selection of resolvables to install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetAllResolvables - Returns list of selected resolvables of a given type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetAllResolvablesForAllTypes - Returns all selected resolvables for all supported types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetResolvables - Returns all resolvables selected for installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetSupportedResolvables - Returns list of resolvables currently supported by this module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IsUniqueID - Return whether a unique ID is already in use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RemoveResolvables - Removes list of packages from pool that is then used by software proposal to propose a selection of resolvables to install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ResetAll - Resets all resolvables to install. Use carefully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SetResolvables - Replaces the current resolvables with new ones. Similar to AddResolvables() but it replaces the list of resolvables instead of adding them to the pool. It always replaces only the part that is identified by the unique_ID.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.1. AddResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Adds list of resolvables to pool that is then used by software proposal to propose a selection of resolvables to install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string unique_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <string> resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 48. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AddResolvables ("y2_kdump", `package, ["yast2-kdump", "kdump"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      // `not_supported is definitely not a supported resolvable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AddResolvables ("test", `not_supported, ["bash"]) -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • supported_resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RemoveResolvables()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.2. GetAllResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns list of selected resolvables of a given type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <string> - list of resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 49. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetAllResolvables (`package) -> ["list", "of", "packages"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetAllResolvables (`pattern) -> ["list", "of", "patterns"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       // not a supported resolvable type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetAllResolvables (`unknown) -> nil
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • supported_resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.3. GetAllResolvablesForAllTypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns all selected resolvables for all supported types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map <symbol, list <string> > - map of resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       `resolvable_type : [ "list", "of", "resolvables" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       `another_type    : [ "list", "of", "resolvables" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 50. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     // No resolvables selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     GetAllResolvablesForAllTypes() -> $[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     // Only patterns selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     GetAllResolvablesForAllTypes() -> $[`pattern : ["some", "patterns"]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     // Also packages selected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     GetAllResolvablesForAllTypes() -> $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       `pattern : ["some", "patterns"],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       `package : ["some", "packages"],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.4. GetResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns all resolvables selected for installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string unique_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <string> - of resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 51. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetResolvables ("y2_kdump", `package) -> ["yast2-kdump", "kdump"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.5. GetSupportedResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns list of resolvables currently supported by this module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <symbol> - of resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 52. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     GetSupportedResolvables() -> [`package, `pattern, ... ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.6. IsUniqueID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return whether a unique ID is already in use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string unique_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether the ID is not in use yet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.7. RemoveResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Removes list of packages from pool that is then used by software proposal to propose a selection of resolvables to install.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string unique_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <string> resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 53. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RemoveResolvables ("y2_kdump", `package, ["kdump"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • supported_resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AddResolvables()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.8. ResetAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resets all resolvables to install. Use carefully.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.3.9. SetResolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Replaces the current resolvables with new ones. Similar to AddResolvables() but it replaces the list of resolvables instead of adding them to the pool. It always replaces only the part that is identified by the unique_ID.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string unique_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list <string> resolvables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    217.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    218. PackagesUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    218.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Gabriele Strattner (gs@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Ladislav SlezĂĄk <lslezak@novell.com>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Purpose: Provides common dialogs related to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • the package management.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    218.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ConfirmLicenses - Display unconfirmed licenses of the selected packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RunPackageSelector - Start the detailed package selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RunPatternSelector - Start the pattern selection dialog. If the UI does not support the PatternSelector, start the detailed selection with "patterns" as the initial view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.3.1. ConfirmLicenses

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Display unconfirmed licenses of the selected packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true when all licenses were accepted (or there was no license to confirm)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.3.2. RunPackageSelector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Start the detailed package selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map<string,any> options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol - Returns `accept or `cancel .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.3.3. RunPatternSelector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Start the pattern selection dialog. If the UI does not support the PatternSelector, start the detailed selection with "patterns" as the initial view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol - Return `accept or `cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      218.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        219. Pam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        YaST intrerface for /etc/pam.d/* files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        219.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        219.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Add - Add options or new PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Enabled - Ask if given PAM module is enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Query - Query PAM configuration for status of given module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Remove - Remove options or PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Set - Add/Remove option or PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Add options or new PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3.2. Enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ask if given PAM module is enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3.3. Query

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Query PAM configuration for status of given module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - keys are 'management groups' (e.g. auth), values are lists of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3.4. Remove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Remove options or PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.3.5. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Add/Remove option or PAM module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          219.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          220. PamSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          YaST intrerface for /etc/default/passwd agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          220.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          220.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • AddValue - Adds a new options to the current list of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetDefaultValue - Reads the value from /etc/default/passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetFile - Returns the given file contents in the map form

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetFiles - Returns list of files currently handled by the module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetGroupHashMethod - Reads the value of default crypt hash for group passwords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetHashMethod - Reads the value of default crypt hash (defined in /etc/default/passwd)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetValues - Returns the values (options) of one type in the given file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RemoveValue - Deletes an options from the current list of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetDefaultValue - Set the value of key in /etc/default/passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetGroupHashMethod - Sets the new value of default crypt hash for group passwords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetHashMethod - Sets the new value of default crypt hash - modifies /etc/default/passwd !

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetValues - Saves the new list of options of one type to given file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Writes all edited files to the disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.1. AddValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adds a new options to the current list of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 54. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             AddValue ("pwcheck", "password", "md5" ])


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.2. GetDefaultValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reads the value from /etc/default/passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.3. GetFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the given file contents in the map form

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - which maps type to list of its options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 55. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             GetFile ("pwcheck") returns $[ "password" : [ "nullok", "cracklib" ] ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.4. GetFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of files currently handled by the module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.5. GetGroupHashMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reads the value of default crypt hash for group passwords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.6. GetHashMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reads the value of default crypt hash (defined in /etc/default/passwd)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.7. GetValues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the values (options) of one type in the given file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 56. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             GetValues ("pwcheck", "password") returns [ "nullok", "cracklib" ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.8. RemoveValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deletes an options from the current list of options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 57. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             RemoveValue ("pwcheck", "password", "md5" ])


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.9. SetDefaultValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the value of key in /etc/default/passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.10. SetGroupHashMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the new value of default crypt hash for group passwords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.11. SetHashMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets the new value of default crypt hash - modifies /etc/default/passwd !

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string hash

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 58. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             SetValues ("md5")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.12. SetValues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Saves the new list of options of one type to given file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 59. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             SetValues ("pwcheck", "password", [ "cracklib", "md5" ])


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.3.13. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Writes all edited files to the disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Pam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            220.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              221. Partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              221.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Thomas Fehr <fehr@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Purpose: Provides information about partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              221.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CurMounted - Return a list with all mounted partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.3.1. CurMounted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return a list with all mounted partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                221.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  222. Popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Commonly used popup dialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  222.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  222.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyMessage - Generic message popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyQuestion - Generic question popup with two buttons.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyQuestion3 - Generic question popup with three buttons.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyQuestionRichText - Show a question that might need scrolling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyTimedMessage - Generic message popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ClearFeedback - Clear feedback message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ConfirmAbort - Confirmation for "Abort" button during installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ContinueCancel - Dialog which displays the "message" and has a <b>Continue</b> and a <b>Cancel</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ContinueCancelHeadline - Dialog which displays the "message" and has a <b>Continue</b> and a <b>Cancel</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Error - Show an error message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ErrorDetails - Show an error message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongError - Show a long error and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongErrorGeometry - Show a long error message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongMessage - Show a long message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongMessageGeometry - Show a long message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongNotify - Show a long notify message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongNotifyGeometry - Show a long notify message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongText - Show a long text that might need scrolling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongWarning - Show a long warning and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LongWarningGeometry - Show a long warning and wait until user clicked "OK". Size of the popup window is adjustable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Message - Show a simple message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • MessageDetails - Show a message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ModuleError - Special error popup for YCP modules that don't work.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • NoHeadline - Indicator for empty headline for popups that can optionally have one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • NoIcon - Indicator for empty icon for popups that can have one - for code readability.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Notify - Show a notification message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • NotifyDetails - Show a notify message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ReallyAbort - Confirmation popup when user clicked "Abort".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ShowFeedback - Show popup with a headline and a message for feedback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ShowFile - Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ShowText - Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ShowTextTimed - Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedAnyQuestion - Timed question popup with two buttons and time display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedError - Show an error message and wait specified amount of time or until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongError - Show a long error message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongErrorGeometry - Show a long error message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongMessage - Show a long message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongMessageGeometry - Show a long message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongNotify - Show a long error message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongNotifyGeometry - Show a long notify message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongWarning - Show a long warning message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedLongWarningGeometry - Show a long warning and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedMessage - Show a message and wait until user clicked "OK" or time is out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedNotify - Show a long notify message and wait until user clicked "OK" or the time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedOKCancel - Display a message with a timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TimedWarning - Show a warning message and wait specified amount of time or until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Warning - Show a warning message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • WarningDetails - Show a warning with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • YesNo - Display a yes/no question and wait for answer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • YesNoHeadline - This dialog displays "message" (a question) and has a <b>Yes</b> and a <b>No</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.1. AnyMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Generic message popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.2. AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Generic question popup with two buttons.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string yes_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string no_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true: first button has been clicked false: second button has been clicked

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 60. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::AnyQuestion( Label::WarningMsg(), "Do really want to ...?", "Install", "Don't do it", `focus_no );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • YesNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ContinueCancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.3. AnyQuestion3

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Generic question popup with three buttons.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string yes_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string no_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string retry_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol - - `yes: first button has been clicked - `no: second button has been clicked - `retry: third button has been clicked

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 61. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::AnyQuestion3( Label::WarningMsg(), _("... failed"), _("Continue"), _("Cancel"), _("Retry"), `focus_yes );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.4. AnyQuestionRichText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a question that might need scrolling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string richtext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer hdim

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer vdim

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string yes_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string no_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - left button pressed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.5. AnyTimedMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Generic message popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.6. ClearFeedback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Clear feedback message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.7. ConfirmAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Confirmation for "Abort" button during installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol severity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 62. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ConfirmAbort ( `painless );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.8. ContinueCancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dialog which displays the "message" and has a <b>Continue</b> and a <b>Cancel</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 63. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ContinueCancel ( "Please insert required CD-ROM." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.9. ContinueCancelHeadline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dialog which displays the "message" and has a <b>Continue</b> and a <b>Cancel</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 64. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ContinueCancelHeadline ( "Short Header", "Going on with action....?" );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ContinueCancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • YesNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.10. Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show an error message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 65. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::Error("The configuration was not succesful." );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Notify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Warning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.11. ErrorDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show an error message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 66. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::ErrorDetails("The configuration was not succesful.", "Service failed to start");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.12. LongError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long error and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.13. LongErrorGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long error message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.14. LongMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.15. LongMessageGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.16. LongNotify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long notify message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.17. LongNotifyGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long notify message and wait until user clicked "OK". Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.18. LongText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long text that might need scrolling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term richtext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer hdim

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer vdim

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 67. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::LongText ( "Package description", `Richtext("<p>Hello, this is a long description .....</p>"), 50, 20 );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.19. LongWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long warning and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.20. LongWarningGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long warning and wait until user clicked "OK". Size of the popup window is adjustable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.21. Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a simple message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 68. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::Message("This is an information about ... ." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Notify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Warning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.22. MessageDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 69. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::MessageDetails("This is an information about ... .", "This service is intended to...");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.23. ModuleError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Special error popup for YCP modules that don't work.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol - `back, `again, `cancel, `next

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 70. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ModuleError( "The module " + symbolof(argterm) + " does not work." );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.24. NoHeadline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indicator for empty headline for popups that can optionally have one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - empty string ("")

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.25. NoIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indicator for empty icon for popups that can have one - for code readability.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.26. Notify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a notification message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 71. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::Notify("Your printer is ready for use." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.27. NotifyDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a notify message with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.28. ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Confirmation popup when user clicked "Abort".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean have_changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true: "abort" confirmed; false: don't abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.29. ShowFeedback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show popup with a headline and a message for feedback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.30. ShowFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 72. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ShowFile ("Boot Messages", "/var/log/boot.msg");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.31. ShowText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 73. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ShowText ("Boot Messages", "kernel panic");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.32. ShowTextTimed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show the contents of an entire file in a popup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 74. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::ShowText ("Boot Messages", "kernel panic");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.33. TimedAnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Timed question popup with two buttons and time display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string yes_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string no_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - True if Yes, False if no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.34. TimedError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show an error message and wait specified amount of time or until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.35. TimedLongError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long error message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.36. TimedLongErrorGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long error message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.37. TimedLongMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.38. TimedLongMessageGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.39. TimedLongNotify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long error message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.40. TimedLongNotifyGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long notify message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.41. TimedLongWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long warning message and wait until user clicked "OK" or time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.42. TimedLongWarningGeometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long warning and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer height

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.43. TimedMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a message and wait until user clicked "OK" or time is out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.44. TimedNotify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a long notify message and wait until user clicked "OK" or the time is out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.45. TimedOKCancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Display a message with a timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true --> "OK" or timer expired<br> false --> "Cancel"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 75. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     boolean ret = Popup::TimedOKCancel("This is a timed message", 2 );


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.46. TimedWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a warning message and wait specified amount of time or until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Warning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.47. Warning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a warning message and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 76. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::Warning("Something is wrong. Please check your configuration." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Notify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.48. WarningDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a warning with Details button and wait until user clicked "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 77. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Popup::WarningDetails("Something is wrong. Please check your configuration.", "possible problem is in..." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.49. YesNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Display a yes/no question and wait for answer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if [Yes] has been pressed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 78. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::YesNo ( "Create a backup of the config files?" );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • YesNoHeadline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ContinueCancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.3.50. YesNoHeadline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This dialog displays "message" (a question) and has a <b>Yes</b> and a <b>No</b> button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if [Yes] has been pressed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 79. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Popup::YesNoHeadline ( "Resize Windows Partition?", "... explanation of dangers ..." );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • YesNo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Icon
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    222.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      223. PortAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Definition of Port Aliases.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      223.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      223.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AllowedPortNameOrNumber - Function returns string describing allowed port name or number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetListOfServiceAliases - Function returns list of aliases (port-names and port-numbers) for requested port-number or port-name. Also the requested name or port is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetPortNumber - Function returns a port number for the port name alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsAllowedPortName - Function returns if the port name is allowed port name (or number).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsKnownPortName - Function returns if the requested port-name is known port. Known port have an IANA alias.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3.1. AllowedPortNameOrNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function returns string describing allowed port name or number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - with description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3.2. GetListOfServiceAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function returns list of aliases (port-names and port-numbers) for requested port-number or port-name. Also the requested name or port is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list <string> - [string] of aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3.3. GetPortNumber

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function returns a port number for the port name alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string port_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3.4. IsAllowedPortName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function returns if the port name is allowed port name (or number).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string port_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.3.5. IsKnownPortName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function returns if the requested port-name is known port. Known port have an IANA alias.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string port_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if is known

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        223.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224. PortRanges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Checking and manipulation with port ranges (iptables).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • $id$

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Module for handling port ranges.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • CreateNewPortRange - Function creates a port range from min and max params. Max must be bigger than min. If something is wrong, it returns an empty string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DividePortsAndPortRanges - Function divides list of ports to the map of ports and port ranges. If with_aliases is 'true' it also returns ports wit their port aliases. Port ranges are not affected with it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FlattenServices - Function tries to flatten services into the minimal list. If ports are already mentioned inside port ranges, they are dropped.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsPortRange - Function returns where the string parameter is a port range. Port ranges are defined by the syntax "min_port_number:max_port_number". Port range means that these maximum and minimum ports define the range of currency in Firewall. Ports defining the range are included in it. This function doesn't check whether the port range is valid or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsValidPortRange - Checks whether the port range is valid.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PortIsInPortranges - Function returns where the port name or port number is included in the list of port ranges. Port ranges must be defined as a string with format "min_port_number:max_port_number".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RemovePortFromPortRanges - Function removes port number from all port ranges. Port must be in its numeric form.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max_port_number - Maximal number of port number, they are in the interval 1-65535 included. The very same value should appear in SuSEFirewall::max_port_number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.1. CreateNewPortRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function creates a port range from min and max params. Max must be bigger than min. If something is wrong, it returns an empty string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer min_pr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer max_pr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - new port range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.2. DividePortsAndPortRanges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function divides list of ports to the map of ports and port ranges. If with_aliases is 'true' it also returns ports wit their port aliases. Port ranges are not affected with it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> unsorted_ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean with_aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map <string, list <string> > - <map <string, list <string> > > of divided ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "ports" : [ list of ports ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "port_ranges" : [ list of port ranges ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.3. FlattenServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function tries to flatten services into the minimal list. If ports are already mentioned inside port ranges, they are dropped.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> old_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> - of flattened services and port ranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.4. IsPortRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function returns where the string parameter is a port range. Port ranges are defined by the syntax "min_port_number:max_port_number". Port range means that these maximum and minimum ports define the range of currency in Firewall. Ports defining the range are included in it. This function doesn't check whether the port range is valid or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string check_this

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - whether the checked string is a port range or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 80. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsPortRange("34:38")      -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsPortRange("0:38")       -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsPortRange("port-range") -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsPortRange("19-22")      -> false


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsValidPortRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.5. IsValidPortRange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Checks whether the port range is valid.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string port_range

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if it is valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 81. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidPortRange("54:135") -> true  // valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidPortRange("135:54") -> false // reverse order
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidPortRange("0:135")  -> false // cannot be from 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidPortRange("135")    -> false // cannot be one number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidPortRange("54-135") -> false // wrong separator


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IsPortRange()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.6. PortIsInPortranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function returns where the port name or port number is included in the list of port ranges. Port ranges must be defined as a string with format "min_port_number:max_port_number".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> port_ranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 82. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               PortIsInPortranges ("130",  ["100:150","10:30"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               PortIsInPortranges ("30",   ["100:150","10:20"]) -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               PortIsInPortranges ("pop3", ["100:150","10:30"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               PortIsInPortranges ("http", ["100:150","10:20"]) -> false


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.3.7. RemovePortFromPortRanges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function removes port number from all port ranges. Port must be in its numeric form.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer port_number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> port_ranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list <string> - of filtered port_ranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 83. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               RemovePortFromPortRanges(25, ["19-88", "152-160"]) -> ["19-24", "26-88", "152-160"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PortAliases::GetPortNumber()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.4.1. max_port_number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Maximal number of port number, they are in the interval 1-65535 included. The very same value should appear in SuSEFirewall::max_port_number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PortAliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          224.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225. PowerManagement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PowerManagement settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - blah blah lahjk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the power-management settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.4. FetchScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            fetch a scheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer clone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.5. FetchSchemes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch all schemes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.6. FindScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find index of a scheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer - scheme index (-1 if not found)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.7. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all power-management settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.8. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Was the settings modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.9. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.10. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all power-management settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.11. StoreScheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Store the current scheme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.12. StoreSchemes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Store all schemes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.13. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.14. TranslatePowersaveText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Translate a text using powersave mo-file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - translated text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.15. TranslateSchemeDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get localized scheme description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - localized scheme decription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.16. TranslateSchemeName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get localized scheme name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - localized scheme name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.3.17. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all power-management settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            225.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              226. Printer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              226.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AddQueue - Add new queue or overwrite existing queue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AutodetectQueues - Autodetect queues by calling a bash script which calls "lpstat -v" and processes its output and stores the results as YCP list in a temporary file and then read the temporary file (SCR::Read) to get the YCP list of @ref autodetected_queue_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ConnectionItems - Create a list of items from the autodetected connections which is used for the SelectionBox in the BasicAddDialog and SelectConnectionDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DeleteQueue - Delete queue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DetermineDriverOptions - Determine driver options by calling a bash script which calls "lpoptions -l" and processes its output and stores the results as YCP list in a temporary file and then read the temporary file (SCR::Read) to get the YCP list of @ref autodetected_queue_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DriverItems - Create a list of items from the PPD database entries which is used for the SelectionBox in the BasicAddDialog and SelectDriverDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DriverOptionItems - Create a list of tree widget items from the driver_options which is used for the tree widget in the DriverOptionsDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Export - Dump the printer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FirewallConfig - Determined and set at runtime in the "Print via Network" and "Sharing" dialogs by calling Printer::FirewallConfig("read") and Printer::FirewallConfig("write")

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Import - Get all printer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • NewQueueName - Create a valid new queue name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • QueueItems - Create the list of queues for the Table in the OverviewDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Read - Initialize printer configuration (checks only the installed packages) see http://en.opensuse.org/YaST/Development/Printer_Enhancement#Basic_Implementation_Principles: for background information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Write - Finish printer configuration (does actually nothing except to exit verbosely) see http://en.opensuse.org/YaST/Development/Printer_Enhancement#Basic_Implementation_Principles: for background information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • connections - Autodetected printers: Determined at runtime via Printer::AutodetectPrinters() which calls the bash script "/usr/lib/YaST2/bin/autodetect_printers" which outputs on stdout a YCP list of @ref autodetected_printer_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • driver_options - Driver options (options in the PPD for one specific existing queue): Determined at runtime via Printer::DetermineDriverOptions( "queue_name") which calls the bash script "/usr/lib/YaST2/bin/determine_printer_driver_options" which outputs on stdout a YCP list of @ref driver_option_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • firewall_config - Firewall configuration: Determined and set at runtime in the "Print via Network" and "Sharing" dialogs by calling Printer::FirewallConfig("read") and Printer::FirewallConfig("write") which calls SuSEFirewall functions to fill in the map @ref firewall_config except "ui_browsing_from_int", "ui_access_from_int", and "ui_deny_from_ext" which are the user settings in the dialog or change the SuSEFirewall settings according to "ui_browsing_from_int", "ui_access_from_int", and "ui_deny_from_ext". The entries are such that "true" is the default, reasonable and intended setting. In particular it is reasonable to deny CUPS Browsing packages (port 631 UDP) from the EXT zone to avoid "print job phishing" by announcing local queue names from a malicious external host, see http://www.cups.org/newsgroups.php?gcups.general+T+Q"print+job+phishing"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • number_chars - Explicite listing of all alphanumeric ASCII characters. The reason is that in certain special locales for example [a-z] is not equivalent to "abcdefghijklmnopqrstuvwxyz" because in certain special languages the 'z' is not the last character in the alphabet, e.g. the Estonian alphabet ends with ... s ... z ... t u v w ... x y (non-ASCII characters omitted here) so that [a-z] would exclude t u v w x y in an Estonian locale. Therefore uppercase and lowercase characters are both explicitely listed to avoid any unexpected result e.g. of "tolower(uppercase_characters)".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ppds - PPD database: the database is created anew in Printer::CreateDatabase() which calls the bash script "/usr/lib/YaST2/bin/create_ppd_database" which outputs on stdout a YCP list of @ref printer_ppd_map where the last list entry is an emtpy map. Printer::CreateDatabase() leaves manufacturer and modelname empty because it would take several minutes (instead of a few seconds) to fill them up (see the comments in create_ppd_database). Both fields can be filled up during runtime for particular PPDs (e.g. for a more detailed PPD selection among several PPDs which match to a particular model or manufacturer but not for all the thousands of PPDs which are installed in the system).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • queue_filter_show_local - Queue filter string: Can be either "all" or "local" or "remote" depending on which kind of queues from the queues list (of queue maps) the user wants to see in the overview dialog. Preset to "all" which indicates that all queues are shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • queues - Autodetected queues: Determined at runtime via Printer::AutodetectQueues() which calls the bash script "/usr/lib/YaST2/bin/autodetect_print_queues" which outputs on stdout a YCP list of @ref autodetected_queue_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_connections_index - Selected autodetected printer index: The index in the autodetected printers list (of connection maps) for the connection which was selected by the user. Preset to -1 which indicates that no connection is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_ppds_index - Selected PPD database index: The index in the PPD database list (of PPD maps) for the PPD which was selected by the user. Preset to -1 which indicates that no PPD is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_queues_index - Selected queue index: The index in the queues list (of queue maps) for the queue which was selected by the user. Preset to -1 which indicates that no queue is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.2. AddQueue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add new queue or overwrite existing queue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string queue_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.3. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.4. AutodetectQueues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Autodetect queues by calling a bash script which calls "lpstat -v" and processes its output and stores the results as YCP list in a temporary file and then read the temporary file (SCR::Read) to get the YCP list of @ref autodetected_queue_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.5. ConnectionItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of items from the autodetected connections which is used for the SelectionBox in the BasicAddDialog and SelectConnectionDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string connection_filter_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - of connections (i.e. DeviceURI, model, and info of the "lpinfo -l -v" output)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.6. DeleteQueue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete queue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string queue_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.7. DetermineDriverOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determine driver options by calling a bash script which calls "lpoptions -l" and processes its output and stores the results as YCP list in a temporary file and then read the temporary file (SCR::Read) to get the YCP list of @ref autodetected_queue_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string queue_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.8. DriverItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of items from the PPD database entries which is used for the SelectionBox in the BasicAddDialog and SelectDriverDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string driver_filter_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean preselection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - of drivers (i.e. the NickName entries of the PPDs)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.9. DriverOptionItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of tree widget items from the driver_options which is used for the tree widget in the DriverOptionsDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string selected_keyword

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string selected_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - of driver options items for a tree widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.10. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dump the printer settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.11. FirewallConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determined and set at runtime in the "Print via Network" and "Sharing" dialogs by calling Printer::FirewallConfig("read") and Printer::FirewallConfig("write")

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.12. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all printer settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.13. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.14. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.15. NewQueueName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a valid new queue name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.16. QueueItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create the list of queues for the Table in the OverviewDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean local

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.17. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Initialize printer configuration (checks only the installed packages) see http://en.opensuse.org/YaST/Development/Printer_Enhancement#Basic_Implementation_Principles: for background information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.3.18. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Finish printer configuration (does actually nothing except to exit verbosely) see http://en.opensuse.org/YaST/Development/Printer_Enhancement#Basic_Implementation_Principles: for background information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true in any case (because it only exits)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.1. connections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Autodetected printers: Determined at runtime via Printer::AutodetectPrinters() which calls the bash script "/usr/lib/YaST2/bin/autodetect_printers" which outputs on stdout a YCP list of @ref autodetected_printer_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autodetected_printer_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "uri":"the full CUPS DeviceURI (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "model":"the manufacturer and model, often "Unknown" (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "deviceID":"what the printer reported as its device ID (often the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "info":"arbitrary info regarding this connection (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "class":"the kind of connection, e.g. "direct","network","file" (may be the empty string)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.2. driver_options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Driver options (options in the PPD for one specific existing queue): Determined at runtime via Printer::DetermineDriverOptions( "queue_name") which calls the bash script "/usr/lib/YaST2/bin/determine_printer_driver_options" which outputs on stdout a YCP list of @ref driver_option_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                driver_option_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "keyword":"the main keyword of the option in the PPD (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "translation":"the translation string of the main keyword (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "values":["a list of the option keywords in the PPD (at least one non-empty entry is required)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               i.e. the values for the main keyword (i.e. the values for this option)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               where the currently set option value of the queue is marked by a leading '*'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               and where the last list entry is an emtpy string"],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "selected":"the curently selected value in the DriverOptionsDialog (may be the empty string)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.3. firewall_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Firewall configuration: Determined and set at runtime in the "Print via Network" and "Sharing" dialogs by calling Printer::FirewallConfig("read") and Printer::FirewallConfig("write") which calls SuSEFirewall functions to fill in the map @ref firewall_config except "ui_browsing_from_int", "ui_access_from_int", and "ui_deny_from_ext" which are the user settings in the dialog or change the SuSEFirewall settings according to "ui_browsing_from_int", "ui_access_from_int", and "ui_deny_from_ext". The entries are such that "true" is the default, reasonable and intended setting. In particular it is reasonable to deny CUPS Browsing packages (port 631 UDP) from the EXT zone to avoid "print job phishing" by announcing local queue names from a malicious external host, see http://www.cups.org/newsgroups.php?gcups.general+T+Q"print+job+phishing"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                firewall_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "suse_firewall_used":"true if Suse Firewall and no other firewall is used",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "firewall_active":"true if Suse Firewall is actually running",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "no_firewall_for_int":"true if Suse Firewall does not potect the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "browsing_from_int":"true if Suse Firewall does not deny CUPS Browsing (port 631 UDP) from the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ui_browsing_from_int":"true if user has set in dialog not to deny CUPS Browsing from the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access_from_int":"true if Suse Firewall does not deny CUPS access (port 631 TCP) from the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ui_access_from_int":"true if user has set in dialog not to deny CUPS access from the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "deny_from_ext":"true if any CUPS access (port 631 UDP and TCP) is denied from the EXT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ui_deny_from_ext":"true if user has set in dialog to deny any CUPS access from the EXT zone"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.4. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.5. number_chars

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Explicite listing of all alphanumeric ASCII characters. The reason is that in certain special locales for example [a-z] is not equivalent to "abcdefghijklmnopqrstuvwxyz" because in certain special languages the 'z' is not the last character in the alphabet, e.g. the Estonian alphabet ends with ... s ... z ... t u v w ... x y (non-ASCII characters omitted here) so that [a-z] would exclude t u v w x y in an Estonian locale. Therefore uppercase and lowercase characters are both explicitely listed to avoid any unexpected result e.g. of "tolower(uppercase_characters)".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.6. ppds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PPD database: the database is created anew in Printer::CreateDatabase() which calls the bash script "/usr/lib/YaST2/bin/create_ppd_database" which outputs on stdout a YCP list of @ref printer_ppd_map where the last list entry is an emtpy map. Printer::CreateDatabase() leaves manufacturer and modelname empty because it would take several minutes (instead of a few seconds) to fill them up (see the comments in create_ppd_database). Both fields can be filled up during runtime for particular PPDs (e.g. for a more detailed PPD selection among several PPDs which match to a particular model or manufacturer but not for all the thousands of PPDs which are installed in the system).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                printer_ppd_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "ppd":"the PPD file name with path below /usr/share/cups/model/ (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "nickname":"the NickName entry in the PPD (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "deviceID":"the 1284DeviceID entry in the PPD (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "language":"the language of the PPD, usually "en" (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "manufacturer":"the Manufacturer entry in the PPD (initially the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "modelname":"the ModelName entry in the PPD (initially the empty string)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.7. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.8. queue_filter_show_local

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Queue filter string: Can be either "all" or "local" or "remote" depending on which kind of queues from the queues list (of queue maps) the user wants to see in the overview dialog. Preset to "all" which indicates that all queues are shown.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.9. queues

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Autodetected queues: Determined at runtime via Printer::AutodetectQueues() which calls the bash script "/usr/lib/YaST2/bin/autodetect_print_queues" which outputs on stdout a YCP list of @ref autodetected_queue_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autodetected_queue_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "name":"the queue name (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "uri":"the full CUPS DeviceURI (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "description":"(may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "location":"(may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ppd":"/etc/cups/ppd/<queue-name>.ppd (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "default":"'yes' if it is a DefaultPrinter in /etc/cups/printers.conf, otherwise the empty string",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "disabled":"'yes' if printing is disabled, otherwise 'no'",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "rejecting":"'yes' if print job are rejected, otherwise 'no'",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "config":"either 'local' if the queue exists in /etc/cups/printers.conf, otherwise 'remote' (required)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.10. selected_connections_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Selected autodetected printer index: The index in the autodetected printers list (of connection maps) for the connection which was selected by the user. Preset to -1 which indicates that no connection is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.11. selected_ppds_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Selected PPD database index: The index in the PPD database list (of PPD maps) for the PPD which was selected by the user. Preset to -1 which indicates that no PPD is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.12. selected_queues_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Selected queue index: The index in the queues list (of queue maps) for the queue which was selected by the user. Preset to -1 which indicates that no queue is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.4.13. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Printerlib
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                226.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  227. Printerlib

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  227.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    227.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ExecuteBashCommand - Wrapper for SCR::Execute to execute a bash command to increase verbosity via y2milestone. It reports the command via y2milestone in any case and it reports exit code, stdout and stderr via y2milestone in case of non-zero exit code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TestAndInstallPackage - Test whether the package is installed (calls 'rpm -q package_name') or test whether the package is available to be installed (Package::Available) and if yes then install it (Package::Install) if it is not yet installed or remove the package (Package::Remove) if it is installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.3.1. ExecuteBashCommand

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Wrapper for SCR::Execute to execute a bash command to increase verbosity via y2milestone. It reports the command via y2milestone in any case and it reports exit code, stdout and stderr via y2milestone in case of non-zero exit code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string bash_commandline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.3.2. TestAndInstallPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Test whether the package is installed (calls 'rpm -q package_name') or test whether the package is available to be installed (Package::Available) and if yes then install it (Package::Install) if it is not yet installed or remove the package (Package::Remove) if it is installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string package_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      227.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228. Product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Product data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • baseproduct - base product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • dist - Distribution: Personal, Professional, etc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • flags - list of flags from content file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • name - General product name and version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • patterns - list of patterns from content file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • product_of_relnotes - map relnotes url to product name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • relnotesurl - url of release notes (downloaded during internet test)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • relnotesurl_all - list of all urls of release notes (downloaded during internet test) bugzilla #160563

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • run_you - Run YOU during the Internet connection test.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • shortlabel - Short label for bootloader entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.3.1. Product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.3.2. ReadProducts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read the products from the package manager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.1. baseproduct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.2. dist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Distribution: Personal, Professional, etc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.3. flags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        list of flags from content file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.4. name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        General product name and version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.5. patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        list of patterns from content file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.6. product_of_relnotes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        map relnotes url to product name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.7. relnotesurl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        url of release notes (downloaded during internet test)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.8. relnotesurl_all

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        list of all urls of release notes (downloaded during internet test) bugzilla #160563

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.9. run_you

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Run YOU during the Internet connection test.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.4.10. shortlabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Short label for bootloader entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageLock
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSERelease
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        228.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          229. ProductControl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Product Control routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          229.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          229.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.1. AddWizardSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Add Wizard Steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> stagemode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.2. DisableModule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Disable given module in installation workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - current list of disabled modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.3. DisableProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Disable given proposal in installation workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string disable_proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - current list of disabled proposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.4. EnableModule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enable given disabled module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - current list of disabled modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.5. EnableProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enable given disabled proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string enable_proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - current list of disabled proposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.6. GetDisabledModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of modules disabled in workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - DisabledModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.7. GetDisabledProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of proposals disabled in workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - DisabledProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.8. GetUseAutomaticConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether automatic configuration will be enabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - if enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.9. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Initialize Product Control

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.10. InitAutomaticConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inits the default value for use_automatic_configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.11. ProductControl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ProductControl Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.12. ReadControlFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read XML Control File

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string controlfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.13. RequiredFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get list of required files for the workflow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - Required files list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.14. ResetAdditionalWorkflowParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resets all additional params for selecting the workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetAdditionalWorkflowParams()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.15. RestartingStep

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return step which restarted YaST (or rebooted the system)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - a map describing the step

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.16. RetranslateWizardSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Retranslate Wizard Steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.17. Run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run Workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.18. RunRequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether is is required to run YaST in the defined stage and mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - if needed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.19. SetAdditionalWorkflowParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets additional params for selecting the workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map <string, any> params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 84. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             SetAdditionalWorkflowParams ($["add_on_mode":"update"]);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             SetAdditionalWorkflowParams ($["add_on_mode":"installation"]);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.20. SetUseAutomaticConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Adjust the automatic configuration to be either enabled or disabled. Enabling it means that second stage will be disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean set_param

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.21. SkippedSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List steps which were skipped since last restart of YaST

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - a list of maps describing the steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.22. UpdateWizardSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update Steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> stagemode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.23. checkArch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check if valid architecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map def

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if arch match

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.24. checkDisabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check if a module is disabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.25. getClientTerm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return term to be used to run module with CallFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map step

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map def

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • any former_result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term - module data with params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.26. getCompleteWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get Workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Workflow map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.27. getLockedProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get Proposal list that can not be changed by the user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string proptype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - list of locked proposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.28. getModeDefaults

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get workflow defaults

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - defaults

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.29. getModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get modules of current Workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol which

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <map> - modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.30. getProposalProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return proposal Label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string proptype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.31. getProposalTextDomain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return text domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.32. getProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get modules of current Workflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string proptype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list < list > - modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.33. getWorkflowLabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get Workflow Label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string wz_td

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.3.34. setClientPrefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set Client Prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Hooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Wizard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            229.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230. ProductCreator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data for configuration of product-creator, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CheckLanguage - Check if there is a language selected in the package manager, if not then select the language used in the UI. Htis prevents the solver from allocating too many resources (see bug #339756)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CopyMiscFiles - CopyMiscFiles Copy other files to directory tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CopyPackages - CopyPackages() Copy selected package to target tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CreateSkeleton - Create Skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • EnableSource - Enable source and get source meta data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Export - Dump the product-creator settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetDirSources - Get all possible sources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Import - Get all product-creator settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PollAbort - Check for pending Abort press

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PrepareConfigs - Prepare map for writing into XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ProductCreator - Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Read all product-creator settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Readisolinux - Return contents of isolinux.cfg from the given source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReallyAbort - If modified, ask for confirmation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetPackageArch - Set the target package architecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Write - Write all product-creator settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WritePatternFile - Write the modified file with pattern definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • checkPackageAvail - Check if selected packages are available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • checkProductDependency - Check Product dependencies and determine product to be used for booting. Also determine what is the main product.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • configSetup - Create XML Configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • getSourceDir - get path to directory source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • getSourceURLs - Get media urls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • setPackages - Set packages to be copied to iso image tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - blah blah lahjk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.2. CheckLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Check if there is a language selected in the package manager, if not then select the language used in the UI. Htis prevents the solver from allocating too many resources (see bug #339756)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.3. CopyMiscFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CopyMiscFiles Copy other files to directory tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string boot_arch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.4. CopyPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CopyPackages() Copy selected package to target tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.5. CreateSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create Skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer base_source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean bootable_product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string boot_architecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.6. EnableSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Enable source and get source meta data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.7. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Dump the product-creator settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.8. GetDirSources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all possible sources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<term> - available enabled sources list for widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.9. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all product-creator settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.10. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.11. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.12. PollAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Check for pending Abort press

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if pending abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.13. PrepareConfigs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Prepare map for writing into XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - lists of configurations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.14. ProductCreator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.15. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read all product-creator settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.16. Readisolinux

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return contents of isolinux.cfg from the given source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - with contents of file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.17. ReallyAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If modified, ask for confirmation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if abort is confirmed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.18. SetPackageArch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the target package architecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string new_arch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.19. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.20. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write all product-creator settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.21. WritePatternFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write the modified file with pattern definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string file_path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<map> patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.22. checkPackageAvail

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Check if selected packages are available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - error message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.23. checkProductDependency

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Check Product dependencies and determine product to be used for booting. Also determine what is the main product.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.24. configSetup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create XML Configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.25. getSourceDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get path to directory source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.26. getSourceURLs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get media urls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<integer> ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list - list of urls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.3.27. setPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set packages to be copied to iso image tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.4.2. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AddOnCreator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AutoinstSoftware
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GPG
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GPGWidgets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PackageAI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Profile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Profile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SourceManager
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              230.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                231. ProductFeatures

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Product features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                231.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                231.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Exports the current set of ProductFeatures

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map <string, map <string, any> > - features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.2. GetBooleanFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - the feature value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.3. GetFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any - the feature value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.4. GetSection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get a complete section for evaluation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> - a map key->value, options in the section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.5. GetStringFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - the feature value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.6. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Imports product features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map <string, map <string, any> > import_settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.7. InitIfNeeded

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize the features structure if needed Either read from /etc/YaST2/ProductFeatures or set default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.8. Restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restore product features in running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.9. Save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Save product features

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.10. SetBooleanFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.11. SetFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.12. SetSection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set a feature section Default values will be used where value not defined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> section_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.3.13. SetStringFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set value of a feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  231.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    232. ProductLicense

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Provide access / dialog for product license

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    232.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    232.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.3.1. AcceptanceNeeded

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether accepting the license manually is requied.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if required

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • BNC #448598

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.3.2. AskLicenseAgreement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Ask user to confirm license agreement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer src_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> patterns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean enable_back

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean base_product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean require_agreement

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.3.3. ShowFullScreenLicenseInInstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Called from the first stage Welcome dialog by clicking on a button

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • any replace_point_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.3.4. ShowLicenseInInstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Used in the first-stage Welcome dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • any replace_point_ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • InstShowInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Wizard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • WorkflowManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      232.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        233. Profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Profile handling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        233.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        233.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.1. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Import Profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string, any> profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.2. Prepare

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Prepare Profile for saving and remove empty data structs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.3. Profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.4. ReadProfileStructure

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read YCP data as the control file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string parsedControlFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.5. ReadProperties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read Profile properties and Version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.6. ReadXML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read XML into YCP data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.7. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Reset profile to initial status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.8. Save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Save YCP data into XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.9. SaveProfileStructure

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Save the current data into a file to be read after a reboot.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string parsedControlFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Restore()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.10. SaveSingleSections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Save sections of current profile to separate files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string,string> - - list of filenames

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.11. convertLVM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Provide Compatibility to older distributions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<map> lvm_standalone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<map> - LVM configuration integrated into partitioning resource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.12. convertRAID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Provide Compatibility to older distributions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<map> raid_standalone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - RAID configuration integrated into partitioning resource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.13. generalCompat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          compatibility to new language,keyboard and timezone client in 10.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.3.14. setElementByList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          this function is a replacement for this code: list<any> l = [ "key1",0,"key3" ]; m[ l ] = v;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<any> l

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any v

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string,any> m

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map<string,any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • AutoinstConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          233.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • autoinstall/xml.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          234. ProfileLocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Process Auto-Installation Location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          234.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          234.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.3.1. Process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Initiate retrieving of control files and Rules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.3.2. ProfileLocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AutoInstallRules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AutoinstConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            234.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • autoinstall/autoinst_dialogs.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • autoinstall/io.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235. ProfileManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data for configuration of profile-manager, input and output funcs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.1. CheckNameValidity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Checks if the name of the new profile consists of valid characters: [a-zA-Z0-9_-.]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.2. GetDefaultResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            get the map of default resource groups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.3. GetHashMarks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gets the hash marks (to show in ProgressPopup) from the hashfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer - number of characters in hashfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.4. GetProgressText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reads the file with the progress informations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean everything

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - the text to show in ProgressPopup (one line in normal case)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.5. GetResourceGroupResources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Gets resources of resource group.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string groupname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - of resources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.6. GetResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns all available resource groups.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,map> - of groups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.7. GetUsernames

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return list of user names available in system First time, read it using yast2-users, use cache for later calls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - of user names (for local users)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.8. GetUsers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return the map of users able to run scpm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.9. GetUsersAllowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check if users are able to switch profiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - the result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.10. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.11. ProgressPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Popup for showing progress informations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string position

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer end

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.12. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all profile-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.13. ReadConfigFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            reads a contents of scpm config file (/etc/scpm.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - false when file doesn't exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.14. ReadResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Reads all available resource groups.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.15. ReadUsers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read the set of users allowed to run SCPM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.16. RebuildDB

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rebuilds SCPM database after changing resources.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.17. Recover

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Calls SCPM::Recover (false) function, which replays journal after the crash (started in separate agen'ts thread, return value must be checked with Wait)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.18. ResetResourceGroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resets one resource group to default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string groupname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.19. ResetResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resets RG's to default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.20. Rollback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Calls SCPM::Recover (true)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.21. SaveResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Save the resource groups edited in YaST UI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.22. SetUsers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Upodate the global map of users

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> current_users

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.23. Wait

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Checks the return value of agent's thread

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if thread finished succesfully

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.24. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all profile-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.25. WriteConfigFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            writes configuration data to scpm config file (/etc/scpm.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.26. WriteResourceGroups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            function for writing modifications in resource groups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.27. WriteSCPMStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enables or disables SCPM (depends on value of enabled variable).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.28. WriteStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            general function for writing status (enable/disable)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.29. WriteStatusFirst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enables SCPM for the first time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.30. WriteUsers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write new set of users allowed to run scpm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.3.31. WriteUsersAllowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write the new status if the users are allowed to run SCPM or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success of the action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.1. conf_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            if SCPM configuration (stored in scpm_conf map) was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.2. enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is SCPM enabled?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.3. hash_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            how many times was progress bar used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.4. initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is SCPM initialized? This is set to true after first enabling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.5. needs_recover

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is SCPM recovery? (after something failed)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.6. needs_reinit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is SCPM re-initialization needed? (possibly after update)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.7. resource_groups

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            all resource groups available; filled by ReadResourceGroups()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.8. resource_groups_deleted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            list of resource groups marked for deletion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.9. resource_groups_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            if resource groups were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.10. scpm_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this map holds the contents of scpm.conf configuration file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.11. scpm_error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When scpm action fails, the error message is stored here by SetError()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.12. status_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Was enabled/disabled status changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.13. users_allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If users are available to switch profiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.4.14. users_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            if list of users was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NetworkService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UsersCache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            235.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              236. Progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Progress bar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              236.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Petr Blahos <pblahos@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              236.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CloseSuperior - Replaces stages of superior progress by an empty help text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CurrentSubprogressType - Get current subprogress type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Finish - Moves progress bar to the end and marks all stages as completed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • New - New complex progress bar with stages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NewProgressIcons - Function adds icon-support to progress dialog. Parameters are the same as for Progress::New() function with one parameter added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NextStage - Advance stage, advance step by 1 and set progress bar caption to that defined in New.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NextStageStep - Jumps to the next stage and sets step to st.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NextStep - Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OpenSuperior - Creates a higher-level progress bar made of stages. Currently it is placed instead of help text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Simple - Create simple progress bar with no stages, only with progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stage - Go to stage st, change progress bar title to title and set progress bar step to step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Step - Changes progress bar value to st.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • StepSuperior - Make one step in a superior progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SubprogressTitle - Set the label of the subprogress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SubprogressType - Create (or remove) a new subprogress above the progress bar, can be use for detailed progress of the current task

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SubprogressValue - Set value of the subprogress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Title - Change progress bar title.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • off - Turns progress bar off. All Progress:: calls return immediatelly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • on - Turns progress bar on after calling Progress::off.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • set - Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • status - Returns currently selected visibility status of all UI-modifying Progress:: functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.1. CloseSuperior

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Replaces stages of superior progress by an empty help text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.2. CurrentSubprogressType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get current subprogress type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol - Current type of the subprogress widget - can be `progress, `tick or `none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.3. Finish

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Moves progress bar to the end and marks all stages as completed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.4. New

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                New complex progress bar with stages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string window_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string progress_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> stg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list tits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.5. NewProgressIcons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function adds icon-support to progress dialog. Parameters are the same as for Progress::New() function with one parameter added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string window_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string progress_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> stg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list tits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string help_textmap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <list <string> > icons_definition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                icons_definition = $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   [ // first 'visible'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "/path/to/icon-highlighted.png"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "/path/to/another-icon-highlighted.png",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   [ // then 'invisible'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "/path/to/icon-gryscale.png",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     nil, // fallback icon will be used
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Function Progress::New()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.6. NextStage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Advance stage, advance step by 1 and set progress bar caption to that defined in New.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.7. NextStageStep

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Jumps to the next stage and sets step to st.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer st

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.8. NextStep

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.9. OpenSuperior

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Creates a higher-level progress bar made of stages. Currently it is placed instead of help text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> stages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.10. Simple

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create simple progress bar with no stages, only with progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string window_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string progress_title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.11. Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Go to stage st, change progress bar title to title and set progress bar step to step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer st

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer step

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.12. Step

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Changes progress bar value to st.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer st

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.13. StepSuperior

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Make one step in a superior progress bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.14. SubprogressTitle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set the label of the subprogress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.15. SubprogressType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create (or remove) a new subprogress above the progress bar, can be use for detailed progress of the current task

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer max_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.16. SubprogressValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set value of the subprogress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.17. Title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Change progress bar title.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string t

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.18. off

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Turns progress bar off. All Progress:: calls return immediatelly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.19. on

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Turns progress bar on after calling Progress::off.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.20. set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - previous state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.3.21. status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns currently selected visibility status of all UI-modifying Progress:: functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - whether the progress bar is used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress::set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress::off

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress::on

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                236.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237. Provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Provider data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Dan Vesely <dan@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Petr Blahos <pblahos@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Add - Add a new provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Clone - Clone the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • CloneSystem - Clone the given system provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Commit - Commit pending operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete - Delete the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Edit - Edit the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Export - Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetCountries - Get list of countries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetCountry - This is a single point of dependence on the Language module of yast2-country-data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetProviders - Get providers from a group (country/other)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import - Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IsUnique - Check if provider name is unique

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Modified - Were the providers changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Overview - Create an overview table with all configured providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProviderType - Return current provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read - Read providers data (custom only) and country mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Select - Select the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SelectSystem - Select the given system provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Summary - Create a textual summary and a list of unconfigured providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Write - Write custom providers data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Current - Current provider structure depends on Type. See providers.rpm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • LastCountry - Last selected country

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Name - Current provider name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Type - Current provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.1. Add

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Add a new provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.2. Clone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Clone the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.3. CloneSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Clone the given system provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.4. Commit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Commit pending operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.5. Delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.6. Edit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Edit the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.7. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Export data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.8. GetCountries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get list of countries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - for SelectionBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.9. GetCountry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This is a single point of dependence on the Language module of yast2-country-data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.10. GetProviders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get providers from a group (country/other)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string country

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string preselect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - of items for SelectionBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.11. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.12. IsUnique

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if provider name is unique

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if OK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.13. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Were the providers changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.14. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create an overview table with all configured providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.15. ProviderType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return current provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - current provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.16. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Read providers data (custom only) and country mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.17. Select

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Select the given provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.18. SelectSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Select the given system provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • path name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.19. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a textual summary and a list of unconfigured providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean split

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.3.20. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Write custom providers data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if sucess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.4.1. Current

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Current provider structure depends on Type. See providers.rpm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.4.2. LastCountry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Last selected country

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.4.3. Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Current provider name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.4.4. Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Current provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  237.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238. Proxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Proxy data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the Routing settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetEnvironment - Function returns an environment usable for curl. The proxy user/password are read from /root/.curlrc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetModified - Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all settings from a map. When called by <name>_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RunTestProxy - Runs tests of the HTTP and FTP proxy

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary - Create proxy summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Write - Write routing settings and apply changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dump the Routing settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - autoinstallation settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.2. GetEnvironment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function returns an environment usable for curl. The proxy user/password are read from /root/.curlrc.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map <string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.3. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get all settings from a map. When called by <name>_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.5. RunTestProxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Runs tests of the HTTP and FTP proxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string http_proxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string https_proxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string ftp_proxy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string proxy_user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string proxy_password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map <string, map <string, any> > - with results of the test

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    return = $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	"HTTP" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"exit" : _exit_code,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stdout" : _stdout,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stderr" : _stderr,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	"HTTPS" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"exit" : _exit_code,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stdout" : _stdout,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stderr" : _stderr,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	"FTP" : $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"exit" : _exit_code,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stdout" : _stdout,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		"stderr" : _stderr,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.6. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.7. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create proxy summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - summary text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.3.8. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write routing settings and apply changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    238.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • network/routines.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • network/runtime.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    239. PulseAudio

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    239.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      239.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          239.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          239.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          239.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          239.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          239.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            240. Punycode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DNS Punycode Handling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            240.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <lukas.ocilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Tags: Unstable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            240.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DecodeDomainName - Decodes the domain name (relative or FQDN) from the Punycode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DecodePunycodes - Converts list of Punycode strings into their UTF-8 representation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DocodeDomainNames - Decodes the list of domain names to their Unicode representation. This function is similar to DecodePunycodes but it works with every string as a domain name (that means every domain name is parsed by dots and separately evaluated).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • EncodeDomainName - Encodes the domain name (relative or FQDN) to the Punycode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • EncodePunycodes - Converts list of UTF-8 strings into their Punycode ASCII repserentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetMaximumCacheSize - Returns the maximum cache size (sum of already converted strings).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetMaximumCacheSize - Offers to set the maximum cache size (sum of already converted strings).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.1. DecodeDomainName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Decodes the domain name (relative or FQDN) from the Punycode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string encoded_domain_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - decoded domain_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 85. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              	DecodeDomainName("xn--ala-qma83eb.xn--jlinka-3mb.go.home")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              		-> "ŞíŞala.jůlinka.go.home"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.2. DecodePunycodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Converts list of Punycode strings into their UTF-8 representation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> punycode_strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> - decoded_strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.3. DocodeDomainNames

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Decodes the list of domain names to their Unicode representation. This function is similar to DecodePunycodes but it works with every string as a domain name (that means every domain name is parsed by dots and separately evaluated).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> encoded_domain_names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> - decoded_domain_names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 86. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               	DocodeDomainNames(["mx1.example.org", "xp3.example.org.", "xn--ala-qma83eb.org.example."])
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              		-> ["mx1.example.org", "xp3.example.org.", "ŞíŞala.org.example."]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.4. EncodeDomainName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Encodes the domain name (relative or FQDN) to the Punycode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string decoded_domain_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - encoded domain_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 87. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              	EncodeDomainName("ŞíŞala.jůlinka.go.home")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              		-> "xn--ala-qma83eb.xn--jlinka-3mb.go.home"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.5. EncodePunycodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Converts list of UTF-8 strings into their Punycode ASCII repserentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> punycode_strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> - encoded_strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.6. GetMaximumCacheSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns the maximum cache size (sum of already converted strings).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer - maximum_cache_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetMaximumCacheSize()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.3.7. SetMaximumCacheSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Offers to set the maximum cache size (sum of already converted strings).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer new_max_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetMaximumCacheSize()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              240.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              241. Region

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              241.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • A region is a list of two integers, the first being the start and the

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • second the length.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              241.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Inside - Checks whether region b lies within region a.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                241.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                241.3.1. Inside

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checks whether region b lies within region a.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<integer> a

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<integer> b

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                241.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                241.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                242. Register

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Registration related stuff

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                242.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • J. Daniel Schmidt <jdsn@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                242.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Export - AutoYaST interface function: Export()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  AutoYaST interface function: Export()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - with the settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RegisterCert
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SourceManager
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • YSR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  242.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    243. Reipl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    243.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export - Dump the reipl settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FindBootPartition - Returns the parameters of the boot partition that was found where the MBR was located.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FindSysfsRoot - Find where sysfs has been mounted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import - Get all reipl settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Has the user modified the dialog values?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ModifyReiplWithBootPartition - Modifys the reipl configuration passed in with what it should be for the detected boot partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read - Read all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ReadState - Read all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SanityCheck - Check to see if reipl is supported by the kernel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetModified - Indicate that the data was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Write - Write all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • WriteState - Write all reipl setting to the firmware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Dump the reipl settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.4. FindBootPartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns the parameters of the boot partition that was found where the MBR was located.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - a list of parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.5. FindSysfsRoot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Find where sysfs has been mounted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - the root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.6. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get all reipl settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.7. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Has the user modified the dialog values?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - return true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.8. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.9. ModifyReiplWithBootPartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Modifys the reipl configuration passed in with what it should be for the detected boot partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> - a map of the new configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.10. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Read all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.11. ReadState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Read all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> - of settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.12. SanityCheck

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check to see if reipl is supported by the kernel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if support exists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.13. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indicate that the data was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.14. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.15. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Write all reipl settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.3.16. WriteState

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Write all reipl setting to the firmware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Confirm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      243.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244. Remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Module for Remote Administration via VNC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Propose - Function proposes a configuration But only if it hasn't been proposed already

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Read the current status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Reset - Reset all module data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary - Create summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3.1. Propose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function proposes a configuration But only if it hasn't been proposed already

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3.2. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read the current status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3.3. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reset all module data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3.4. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - summary text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.3.5. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update the SCR according to network settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.4.1. allow_administration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Allow remote administration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.4.2. default_dm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Default display manager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        244.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • network/routines.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        245. Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Messages handling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        245.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        245.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AnyQuestion - Question with headline and Yes/No Buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ClearAll - Clear all stored messages (errors, messages and warnings)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ClearErrors - Clear stored errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ClearMessages - Clear stored messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ClearWarnings - Clear stored warnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ClearYesNoMessages - Clear stored yes/no messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DisplayErrors - Error popup dialog can displayed immediately when new error is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DisplayMessages - Message popup dialog can be displayed immediately when a new message is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DisplayWarnings - Warning popup dialog can displayed immediately when new warningr is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DisplayYesNoMessages - Yes/No Message popup dialog can be displayed immediately when a new message is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Error - Store new error text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Dump the Report settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetMessages - Create rich text string from stored warning, message or error messages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Get all the Report configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LogErrors - Set warnings logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LogMessages - Set messages logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LogWarnings - Set warnings logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LogYesNoMessages - Set yes/no messages logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LongError - Store new error text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LongMessage - Store new message text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LongWarning - Store new warning text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Message - Store new message text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NumErrors - Return number of stored errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NumMessages - Return number of stored messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NumWarnings - Return number of stored warnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • NumYesNoMessages - Return number of stored yes/no messages

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ShowText - Store new message text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary - Summary of current settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Warning - Store new warning text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.1. AnyQuestion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Question with headline and Yes/No Buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string yes_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string no_button_message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - True if Yes is pressed, otherwise false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.2. ClearAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear all stored messages (errors, messages and warnings)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.3. ClearErrors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear stored errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.4. ClearMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear stored messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.5. ClearWarnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear stored warnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.6. ClearYesNoMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Clear stored yes/no messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.7. DisplayErrors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Error popup dialog can displayed immediately when new error is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.8. DisplayMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Message popup dialog can be displayed immediately when a new message is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.9. DisplayWarnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Warning popup dialog can displayed immediately when new warningr is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.10. DisplayYesNoMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Yes/No Message popup dialog can be displayed immediately when a new message is stored.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean display

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.11. Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new error text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string error_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.12. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Dump the Report settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - Map with settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.13. GetMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create rich text string from stored warning, message or error messages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean w

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean e

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean m

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean ynm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - rich text string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.14. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.15. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get all the Report configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.16. LogErrors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set warnings logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.17. LogMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set messages logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.18. LogWarnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set warnings logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.19. LogYesNoMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set yes/no messages logging to .y2log file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.20. LongError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new error text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string error_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.21. LongMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new message text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string message_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.22. LongWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new warning text, the text is displayed in a richtext widget - long lines are automatically wrapped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string warning_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.23. Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new message text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string message_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.24. NumErrors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return number of stored errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - number of errors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.25. NumMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return number of stored messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - number of messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.26. NumWarnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return number of stored warnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - number of warnings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.27. NumYesNoMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return number of stored yes/no messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - number of messages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.28. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.29. ShowText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new message text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string headline_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string message_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.30. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Summary of current settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Html formatted configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.3.31. Warning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Store new warning text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string warning_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          245.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246. Restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data for configuration of restore, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.1. ActivateBootloader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Activate boot loader configuration if requested. Uses variable Restore::runbootloader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.2. ClearInstalledPackagesCache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Clear cache of installed packages. Next use of GetActualInstalledPackages() function will reread installed packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the restore settings to a single map - for use by autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.4. GetActualInstalledPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return installed packages. Result is cached in Restore module, so only first use takes long time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> - Map $[ "packagename" : "version" ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.5. GetArchiveComment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return user comment stored in archive. Comment is stored in file info/comment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Archive comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.6. GetArchiveDate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return date when backup archive was created. Date is stored in archive in file info/date.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.7. GetArchiveFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return list of files in the backup archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - Files in the archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.8. GetArchiveHostname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return host name of machine on which backup archive was created. Host name is stored in archive in file info/hostname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Host name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.9. GetArchiveInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return restore configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map<string, any> > - Map $[ "packagename" : $["vers" : "version", "files" : ["files in the archive"], "prefix" : "installprefix", "descr" : "Short description", "sel_type" : "X", "sel_file" : ["selected files to restore"] ] ], possible values for "sel_type" key are: "X" - restore all files from archive, " " - do not restore this package, "P" - partial restore, restore only selected files at "sel_file" key. Package name "" means files not owned by any package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.10. GetArchiveInstalledPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return map with packages installed at backup time (form is $["package name" : "version"]).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> - Installed packages at backup time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.11. GetArchiveName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return name of backup archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.12. GetExtraPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return extra packages (packages which are installed at restore time, but at restore time they are installed)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,map<string,string> > - Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.13. GetInputName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return name of backup archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Input name file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.14. GetMismatchedPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return packages which have different version at backup archive and in system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map <string, string> > - Map $[ "packagename" : $[ "inst": "installed version", "ver" : "version at backup time, "descr" : "Short description of the package"]], key description is present only if decription exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.15. GetMissingPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return missing packages (packages which were installed at backup time, but at restore time they are not installed)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map<string, string> > - Map $[ "packagename" : $[ "ver" : "version", "descr" : "Short description of the package"]], key description is present only if decription exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.16. GetSelectedPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns selected packages (even partially).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map> - Map with same keys as map returned by GetArchiveInfo()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.17. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all restore settings - for use by autoinstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.18. IsMultiVolume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selected archive has more parts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - boolen True if archive have more than one part.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.19. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return modified flag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.20. MountInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mount input source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Map $[ "success" : boolean (true on success), "mpoint" : string (mount point), "file" : string (file name on the local system) ];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.21. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read contents of archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True if archive was succesfully read, otherwise false (file does not exist, not tar archive, broken archive, archive not created by Backup module, ...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.22. ReadActualInstalledPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read installed packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> - Map $[ "packagename" : "version" ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.23. ReadNextVolume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read next volume of multi volume archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Map $[ "success" : boolean (true on success), "lastvolume" : boolean (true if archive is last volume) ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.24. ResetAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Clear all settings (archive and list of installed packages)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.25. ResetArchiveSelection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Clear all archive settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.26. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.27. SetRestoreSelection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Change restore selection of package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pkgname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.28. SetSelectionProperty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set selection in _auto client and display properties of archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,map> settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.29. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create restore configuration summary. Used in autoinstallation restore module configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - rich text summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.30. TestAllVolumes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Test all volumes together

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True: all volumes are OK, false: an error occured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.31. TotalFilesToRestore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return number of files which will be unpacked from archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer - Total selected files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.32. TotalPackagesToRestore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return number of packages which will be restored from archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer - Total selected packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.33. Umount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Umount mounted file system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.3.34. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Restore files from archive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string targetdir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Map $[ "aborted" : boolean, "restored" : [ "restored file" ], "failed" : [ "failed file" ] ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.4.1. restoreRPMdb

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rewrite RPM db - unapack /var/lib/rpm/* files from backup if present

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.4.2. runSuSEconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run SuSEconfig after files are restored

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.4.3. runbootloader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run lilo after files are restored

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            246.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              247. RichText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Rich text manipulation routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              247.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stano Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              247.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • DetectRichText - Parse provided text and see if it contains richtext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Rich2Plain - Convert a richtext string into a formatted plain text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.3.1. DetectRichText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parse provided text and see if it contains richtext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.3.2. Rich2Plain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Convert a richtext string into a formatted plain text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string richtext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - the converted text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                247.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  248. RootPart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  248.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Purpose: Responsible for searching of root partitions and

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • mounting of target partitions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  248.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AnyQuestionAnyButtonsDetails -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • FindRootPartitions - Find all valid root partitions and place the result in rootPartitions. The partitions are mounted and unmounted again (to Installation::destdir). Loads a bunch of kernel modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetInfoOfSelected - Get the key what of the selected root partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IncompleteInstallationDetected - Checks the partition whether it contains an incomplete installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • MountPartitions - Mounting root-partition; reading fstab and mounting read partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SetSelectedToValid - Set the selected root partition to some valid one. Only make sense if the number of valid root partition is one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • UnmountPartitions - Unmount all mounted partitions, deactivate swaps, detach loopback devices. Uses list activated to make actions in reverse order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.1. AnyQuestionAnyButtonsDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string headline

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string question

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string button_yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string button_no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.2. FindRootPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Find all valid root partitions and place the result in rootPartitions. The partitions are mounted and unmounted again (to Installation::destdir). Loads a bunch of kernel modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.3. GetInfoOfSelected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the key what of the selected root partition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol what

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.4. IncompleteInstallationDetected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Checks the partition whether it contains an incomplete installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string mounted_to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if incomplete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • BNC #441919

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.5. MountPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mounting root-partition; reading fstab and mounting read partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string root_device_current

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.6. SetSelectedToValid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the selected root partition to some valid one. Only make sense if the number of valid root partition is one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.3.7. UnmountPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Unmount all mounted partitions, deactivate swaps, detach loopback devices. Uses list activated to make actions in reverse order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean keep_in_target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SuSERelease
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    248.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • partitioning/custom_part_dialogs.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249. Routing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Routing data (/etc/sysconfig/network/routes)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the Routing settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetDevices - Get the current devices list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetGateway - Get the default gateway

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all the Routing configuration from a map. When called by routing_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Read - Read routing settings If no routes, sets a default gateway from Detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ReadFromGateway - Set the routes to contain only the default route, if it is defined. Used when there is nothing better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RemoveDefaultGw - Remove route with default gateway from Routes list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SetDevices - Set the available devices list (for expert routing dialog)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary - Create routing text summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Write - Write routing settings and apply changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Forward - Enable IP forwarding .sysconfig.sysctl.IP_FORWARD

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Routes - All routes list <map <string, string> >: keys: destination, gateway, netmask, [device, [extrapara]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dump the Routing settings to a map, for autoinstallation use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - autoinstallation settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.2. GetDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the current devices list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list - devices list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.3. GetGateway

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the default gateway

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - gateway

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get all the Routing configuration from a map. When called by routing_auto (preparing autoinstallation data) the map may be empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.6. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Read routing settings If no routes, sets a default gateway from Detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.7. ReadFromGateway

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the routes to contain only the default route, if it is defined. Used when there is nothing better.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string gw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.8. RemoveDefaultGw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove route with default gateway from Routes list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.9. SetDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the available devices list (for expert routing dialog)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list devs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create routing text summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - summary text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write routing settings and apply changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.4.1. Forward

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable IP forwarding .sysconfig.sysctl.IP_FORWARD

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.4.2. Routes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    All routes list <map <string, string> >: keys: destination, gateway, netmask, [device, [extrapara]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NetHwDetection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    249.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • network/routines.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • network/runtime.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    250. Runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Service manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    250.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Petr Blahos <pblahos@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    250.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        250.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        250.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        250.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        250.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        250.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251. RunlevelEd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Data for configuration of services, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Petr Blahos <pblahos@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Martin Lazar <mlazar@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • CheckPortmap - Check for portmap. Portmap should be started if inetd, nfs, nfsserver, nis, ... is started. This checks the dependency.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ClearServices - Set all dirty services as clean and tries to read original "start"/"stop" for them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DotRequires -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - Export user settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FilterAlreadyDoneServices - Gets a list of dependent services and a target state they should be in. Filters out those that are already in the target state. If both init_time and run_time are on, a conjunction is needed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetModified - Returns true if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetRunlevel4Support - Returns whether runlevel 4 is supported in RLEd.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import - Import user settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Init - Init function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ProposalSummary -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read - Read settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ServiceDependencies - Resolve which services need to be enabled/disabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ServiceInstall - Enable specified service, and all required services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ServiceRemove - Disable specified service, and all dependence services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetModified - Function sets an internal variable indicating that any settings were modified to "true". Used for autoinst cloning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetRunlevel4Support - Sets whether runlevel 4 should be supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • StartContainsImplicitly - Is a service started in a runlevel, given the list of rulevels it is started in? This looks like a simple contains, but "B" implicitly expands to all runlevels. See also bug #17234.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Save changed services into proper runlevels. Save also changed default runlevel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • getDefaultPicker - Returns items for default runlevel combo box. (Excludes 0, 1, 6, S and B)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • getRunlevelDescr - Returns textual runlevel description. Descriptions are hard-coded in ycp script.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • isDirty - Were some settings changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • isDisabled - Is a service disabled? Checks whether the default runlevel is in the list of runlevels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • current - Current runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default_runlevel - Default runlevel (after boot)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • runlevels - List of all runlevels available in the system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • service_list - List of all service names. Filled by Read, used to get all services' status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • services - List of all services. Each item is a map described above. @ref service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • x11_selected - Proposal parameter: if it changes, we repropose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.1. CheckPortmap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check for portmap. Portmap should be started if inetd, nfs, nfsserver, nis, ... is started. This checks the dependency.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - name of the first enabled service that requires portmap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.2. ClearServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set all dirty services as clean and tries to read original "start"/"stop" for them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.3. DotRequires

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - a graphviz graph of the service dependencies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.4. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Export user settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - user settings:<pre>$[ "services": $[ map of dirty services ], "default": the default runlevel, if changed, ]</pre>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.5. FilterAlreadyDoneServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gets a list of dependent services and a target state they should be in. Filters out those that are already in the target state. If both init_time and run_time are on, a conjunction is needed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> svcs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> rls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean init_time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean run_time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.6. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.7. GetRunlevel4Support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns whether runlevel 4 is supported in RLEd.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - supported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.8. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Import user settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.9. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Init function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FATE #303798: YaST2 runlevel editor: offer easy enablement and configuration of runlevel 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.10. ProposalSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Html formatted summary for the installation proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.11. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.12. ServiceDependencies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Resolve which services need to be enabled/disabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> - a list of services (excluding itself) required to start a service (enable) or to be stopped because they require the service (disable), ordered by their dependencies. Missing services are included, system facilities excluded.<br> If dependencies are disabled, returns an empty list, as if there were no dependencies.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.13. ServiceInstall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Enable specified service, and all required services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> rls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - 0 = ok, 1 = service not found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.14. ServiceRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Disable specified service, and all dependence services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> rls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • integer - 0 = ok

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.15. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function sets an internal variable indicating that any settings were modified to "true". Used for autoinst cloning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.16. SetRunlevel4Support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Sets whether runlevel 4 should be supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean new_state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FATE #303798

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.17. StartContainsImplicitly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Is a service started in a runlevel, given the list of rulevels it is started in? This looks like a simple contains, but "B" implicitly expands to all runlevels. See also bug #17234.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<string> rls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string rl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - should it be running in rl?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.18. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Html formatted configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.19. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Save changed services into proper runlevels. Save also changed default runlevel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.20. getDefaultPicker

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns items for default runlevel combo box. (Excludes 0, 1, 6, S and B)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • symbol mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list - List of items. Default is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.21. getRunlevelDescr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns textual runlevel description. Descriptions are hard-coded in ycp script.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string rl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Description.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.22. isDirty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Were some settings changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if yes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.3.23. isDisabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Is a service disabled? Checks whether the default runlevel is in the list of runlevels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true if service is disabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.1. current

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Current runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.2. default_runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Default runlevel (after boot)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.3. runlevels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of all runlevels available in the system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.4. service_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of all service names. Filled by Read, used to get all services' status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.5. services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of all services. Each item is a map described above. @ref service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.4.6. x11_selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Proposal parameter: if it changes, we repropose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          251.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • runlevel/toposort.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          252. SLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access to SLP Agent functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          252.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          252.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • AttrSummary - Attribute summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DeReg - Deregister service with SLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DeRegFile - De-Register service with SLP by removing the reg file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FindAttrs - Find attributes of a service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FindSrvTypes - Issues an SLP service type request for service types in the scopes indicated by the pcScopeList.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FindSrvs - Issue the query for services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetAttrMap - Find attributes of a service and return a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetUnicastAttrMap - Find attributes (using unicast query) of a service and return a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • MatchType - Match Srv Type and return all data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Reg - Register service with SLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RegFile - Register service with SLP using a reg file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • UnicastFindAttrs - Find attributes of a service using a unicast query

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.1. AttrSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Attribute summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> Attrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.2. DeReg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deregister service with SLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.3. DeRegFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            De-Register service with SLP by removing the reg file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string regfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.4. FindAttrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find attributes of a service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcURLOrServiceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - attributes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.5. FindSrvTypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Issues an SLP service type request for service types in the scopes indicated by the pcScopeList.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcNamingAuthority

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcScopeList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - Service Types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.6. FindSrvs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Issue the query for services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcServiceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcScopeList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - List of Services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.7. GetAttrMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find attributes of a service and return a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcURLOrServiceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> - attributes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.8. GetUnicastAttrMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find attributes (using unicast query) of a service and return a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcURLOrServiceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> - attributes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.9. MatchType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Match Srv Type and return all data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string match

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - list of services matching with all relevant data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.10. Reg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Register service with SLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.11. RegFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Register service with SLP using a reg file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string,string> attr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string regfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on Success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.3.12. UnicastFindAttrs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Find attributes of a service using a unicast query

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string pcURLOrServiceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - attributes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            252.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253. Samba

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data for configuration of samba-client, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AdjustSharesServices - adjust the services for sharing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AutoPackages - Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Export - Dump the samba-client settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetDHCP - Check if dhcp.conf is included in smb.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetGuessAccess - check if shares guest access is allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetHostsResolution - Read /etc/nsswitch.conf and check if WINS is used for hosts resolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetMaxShares - get number of max shares from smb.conf; 0 mean shares are not enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetModified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetPAMMountVolumes - Return the list of 'volume' entries from pam_mount.conf.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetSSHSupport - Get the current status of ssh single-sign-on support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetWinbind - Get a winbind status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetWinbindCaching - Get the current status of winbind caching

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetWorkgroup - Get a host workgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Import - Get all samba-client settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Read all samba-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadMkHomeDir - Read the state of mkhomedir in /etc/pam.d/common-session (bug #143519)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadPAMMount - Read the data from /etc/security/pam_mount.conf.xml regarding mounting user's home directories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadSSHSupport - Read the current status of ssh single-sign-on support (fate #303415)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ReadSharesSetting - Read user shares settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetDHCP - Set the support of DHCP (include dhcp.conf in smb.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetGuessAccess - Set the new value for guest access (#144787)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetHostsResolution - Set the new value for hosts resolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetMkHomeDir - Set the new value of mkhomedir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetPAMMountVolumes - Set the new list of 'volume' entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetSSHSupport - Set the new value for sh single-sign-on support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetShares - set the new values for user shares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetStartFAM - update the information if FAM should be started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetWinbind - Set a windind status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetWinbindCaching - Set the new value for winbind caching (see bug #143927)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetWorkgroup - Set a host workgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ShortSummary - Create shorter textual summary and a list of unconfigured options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary - Create a textual summary and a list of unconfigured options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • UpdatedArchPackages - Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Write - Write all samba-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WriteHostsResolution - Write /etc/nsswitch.conf if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WriteMkHomeDir - Write the new value of pam_mkhomedir to /etc/pam.d/common-session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WritePAMMount - Write the changes to /etc/security/pam_mount.conf.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WriteSSHSupport - Write the new value for sh single-sign-on support (fate #303415)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WriteShares - create the shares directory with correct rights

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • globals_configured - Are globals already configured (for AutoYaST)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mkhomedir - if pam_mkhomedir is set in /etc/pam.d/commond-session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • password_data - map with user name and password (used for autoinstallation only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • start_fam - If FAM should be started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • winbind_enabled - Should be winbind enabled?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.1. AdjustSharesServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              adjust the services for sharing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return required packages for auto-installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - of packages to be installed and to be removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Dump the samba-client settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.4. GetDHCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Check if dhcp.conf is included in smb.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.5. GetGuessAccess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              check if shares guest access is allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.6. GetHostsResolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read /etc/nsswitch.conf and check if WINS is used for hosts resolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.7. GetMaxShares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get number of max shares from smb.conf; 0 mean shares are not enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.8. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.9. GetPAMMountVolumes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return the list of 'volume' entries from pam_mount.conf.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.10. GetSSHSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the current status of ssh single-sign-on support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.11. GetWinbind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get a winbind status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - booleand a winbind status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.12. GetWinbindCaching

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the current status of winbind caching

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.13. GetWorkgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get a host workgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - a new workgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.14. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get all samba-client settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.15. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read all samba-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.16. ReadMkHomeDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read the state of mkhomedir in /etc/pam.d/common-session (bug #143519)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.17. ReadPAMMount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read the data from /etc/security/pam_mount.conf.xml regarding mounting user's home directories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.18. ReadSSHSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read the current status of ssh single-sign-on support (fate #303415)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.19. ReadSharesSetting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Read user shares settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.20. SetDHCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the support of DHCP (include dhcp.conf in smb.conf)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean new

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - if status was changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.21. SetGuessAccess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new value for guest access (#144787)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean guest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.22. SetHostsResolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new value for hosts resolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean resolve

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.23. SetMkHomeDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new value of mkhomedir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean new_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.24. SetPAMMountVolumes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new list of 'volume' entries

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<map> new_volumes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.25. SetSSHSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new value for sh single-sign-on support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.26. SetShares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set the new values for user shares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer max

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string group

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.27. SetStartFAM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              update the information if FAM should be started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean fam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - current fam status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.28. SetWinbind

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set a windind status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.29. SetWinbindCaching

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the new value for winbind caching (see bug #143927)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.30. SetWorkgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set a host workgroup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string group

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.31. ShortSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create shorter textual summary and a list of unconfigured options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.32. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create a textual summary and a list of unconfigured options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.33. UpdatedArchPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return list of architecture specific packages (derived from package list given as parameter) merged with the packages in parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string> packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.34. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write all samba-client settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.35. WriteHostsResolution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write /etc/nsswitch.conf if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.36. WriteMkHomeDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write the new value of pam_mkhomedir to /etc/pam.d/common-session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.37. WritePAMMount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write the changes to /etc/security/pam_mount.conf.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.38. WriteSSHSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write the new value for sh single-sign-on support (fate #303415)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.3.39. WriteShares

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              create the shares directory with correct rights

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.1. globals_configured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Are globals already configured (for AutoYaST)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.2. mkhomedir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              if pam_mkhomedir is set in /etc/pam.d/commond-session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.3. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.4. password_data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              map with user name and password (used for autoinstallation only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.5. start_fam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If FAM should be started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.6. winbind_enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Should be winbind enabled?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.4.7. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Autologin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NetworkConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Nsswitch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Pam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SambaAD
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SambaConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SambaNetJoin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SambaNmbLookup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SambaWinbind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              253.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254. Scanner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scanner settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Johannes Meixner <jsmeix@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ActivateBackend - Activate the backend in /etc/sane.d/dll.conf according to the specified backend_name or if the specified backend_name is the empty string then set the backend_name according to a specified database_index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AutoPackages - Return packages needed to be installed and removed during autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DeactivateBackend - Deactivate the backend in /etc/sane.d/dll.conf according to the specified backend_name or if the specified backend_name is the empty string then set the backend_name according to a specified database_index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DetermineNetworkScanningConfig - Determine the network scanning config by calling a bash script which calls "grep ... /etc/sane.d/net.conf" and "grep ... /etc/sane.d/saned.conf" and processes its output and stores the results as YCP map in a temporary file and then read the temporary file (SCR::Read) to get the YCP map. Additionally call SuSEFirewall functions to determine the firewall settings regarding remote access to the saned (service "sane-port" 6566/tcp,6566/udp).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Export - Dump the scanner settings to a single map. For use by autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Import - Get all scanner settings from the first parameter. For use by autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ModelItems - Create a list of items from the database entries which is used for the SelectionBox in the SelectModelDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Modified - Something was committed to the system?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OverviewContents - Create the content for WizardHW::SetContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Read - Read all scanner settings: - Check installed packages - Read or create the scanner database - Determine active scanners - Determine active backends - Try to autodetect USB and SCSI scanners and HP all-in-one USB and NETWORK scanners

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • RestartDetection - Restart the whole autodetection by calling all autodetection functions in the same order as during the initial Read(): DetermineActiveScanners results a new active_scanners map which is empty if nothing was detected or if DetermineActiveScanners fails. DetermineActiveBackends results a new active_backends list which is empty if nothing was detected or if DetermineActiveBackends fails. AutodetectScanners results a new autodetected_scanners map which is empty if nothing was detected or if AutodetectScanners fails. RestartDetection is called when the user restarts the detection in the OverviewDialog and if testing of an active scanner failed (see the TestBackend function). The result is that all information in the OverviewDialog is recreated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • RunHpsetup - Run hp-setup:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetupNetworkScanningConfig - Setup the network scanning config by calling a bash script which activates or deactivates the "net" backend and which writes into /etc/sane.d/net.conf, /etc/sane.d/saned.conf, and /etc/xinetd.d/sane-port and reloads or starts the xinetd dependig on whether it is running or not. Additionally call SuSEFirewall functions to commit changed firewall settings regarding remote access to the saned (service "sane-port" 6566/tcp,6566/udp).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TestBackend - Test the backend according to the specified backend_name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Write - Write scanner settings: - Save the actual environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • active_backends - Active backends: Determined at runtime via Scanner::DetermineActiveBackends() which calls the bash script "/usr/lib/YaST2/bin/determine_active_scanner_backends YCP" which outputs on stdout a YCP list of backends [ "The name of the backend", ... "" ] where the last list entry is an empty string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • active_scanners - Active scanners: Determined at runtime via Scanner::DetermineActiveScanners() which calls the bash script "/usr/lib/YaST2/bin/determine_active_scanners YCP" which outputs on stdout a YCP list of @ref active_scanner_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • actual_environment - Environment values: It is a map of @ref environment_values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • autodetected_scanners - Autodetected scanners: Determined at runtime via Scanner::AutodetectScanners() which calls the bash script /usr/lib/YaST2/bin/autodetect_scanners YCP which calls "sane-find-scanner" and (if available) "hp-probe" which may result for example the description strings in the example below. Only in case of USB an automated extraction of manufacturer is possible. If there are two '[...]' substrings then the first one is the manufacturer and the second one is the model (but there may be only one or none substring). The result is a YCP list of @ref autodetected_scanner_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • database - Scanner database: When package version of sane-backends/hplip/iscan/iscan-free changes the database is created anew in Scanner::Read() which calls the bash script "/usr/lib/YaST2/bin/create_scanner_database YCP" which outputs on stdout a YCP list of @ref scanner_model_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • database_manufacturers - Manufacturer list: List of unique manufacturer names. Derived during startup from the scanner database (in the Read function stage "Read or create the scanner database").

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • database_usbids - Known USB scanner USB IDs list: List of known USB scanner USB vendor and product IDs. Derived during startup from the scanner database (in the Read function stage "Read or create the scanner database").

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • firewall_config - Firewall network scanning configuration: Determined at runtime via Scanner::DetermineNetworkScanningConfig() which calls SuSEFirewall functions to fill the map @ref firewall_config except "ui_no_firewall_for_int" and "ui_deny_from_ext" which are the user settings in the dialog. The entries are such that "true" is the default, reasonable and intended setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ignore_unknown_USB_scanners - Ignore unknown USB scanners: Whether or not unknown USB scanners should be ignored during AutodetectScanners. As there is no USB device class for scanners (they have the unspecific USB device class 255), sane-find-scanner can only do some best guess to determine if a USB device is a scanner or not. Therefore also other USB devices with the device class 255 are reported as possible USB scanners. Preset to true so that initially only scanners for which the USB IDs are known by SANE are shown. It changes to false (i.e. show all USB devices with the device class 255 as possible USB scanners) when the user explicitely requests a "Restart Detection" in the OverviewDialog. A second "Restart Detection" changes it back to true so that "Restart Detection" toggles it. The idea behind is that the user can simply "Restart Detection" as often as he likes until the result is o.k. for him because "Restart Detection" does not cause harm and it avoids a separated button or check-box to determine the autodetection behaviour which would require additional explanatory (complicated) help text about the whole stuff. Examples: Assume there is a known powered-off USB scanner and another USB device with class 255: Initially nothing is shown. After the first "Restart Detection" only the other USB device with class 255 is shown. This unexpected result makes the user think about what is wrong and he powers-on the scanner. After the second "Restart Detection" only the USB scanner is shown. Assume there is an unknown powered-off USB scanner and another USB device with class 255. Initially nothing is shown. After the first "Restart Detection" only the other USB device with class 255 is shown. This unexpected result makes the user think about what is wrong and he powers-on the scanner. After the second "Restart Detection" nothing is shown. A third "Restart Detection" shows both the USB scanner and the other USB device with class 255. This is the best possible result because it is not possible to show only the unknown USB scanner.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • modified - Something was committed to the system? True if system may have been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • network_scanning_config - Network scanning configuration: Determined at runtime via Scanner::DetermineNetworkScanningConfig() which calls the bash script "/usr/lib/YaST2/bin/determine_network_scanner_config YCP" which outputs on stdout a YCP map @ref network_scanner_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • number_chars - Explicite listing of all alphanumeric ASCII characters. The reason is that in certain special locales for example [a-z] is not equivalent to "abcdefghijklmnopqrstuvwxyz" because in certain special languages the 'z' is not the last character in the alphabet, e.g. the Estonian alphabet ends with ... s ... z ... t u v w ... x y (non-ASCII characters omitted here) so that [a-z] would exclude t u v w x y in an Estonian locale. Therefore uppercase and lowercase characters are both explicitely listed to avoid any unexpected result e.g. of "tolower(uppercase_characters)".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_autodetected_scanners_index - Selected autodetected scanners index: The index in the autodetected scanners list (of autodetected scanner maps) for the model which was selected by the user in the OverviewDialog. Preset to -1 which indicates that no model is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • selected_model_database_index - Selected model database index: The index in the scanner database list (of model maps) for the model which was selected by the user in the SelectModelDialog. Preset to -1 which indicates that no model is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if not modified and user requested abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.2. ActivateBackend

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Activate the backend in /etc/sane.d/dll.conf according to the specified backend_name or if the specified backend_name is the empty string then set the backend_name according to a specified database_index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string backend_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer database_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean user_confirmation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.3. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return packages needed to be installed and removed during autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.4. DeactivateBackend

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Deactivate the backend in /etc/sane.d/dll.conf according to the specified backend_name or if the specified backend_name is the empty string then set the backend_name according to a specified database_index.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string backend_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer database_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean user_confirmation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.5. DetermineNetworkScanningConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Determine the network scanning config by calling a bash script which calls "grep ... /etc/sane.d/net.conf" and "grep ... /etc/sane.d/saned.conf" and processes its output and stores the results as YCP map in a temporary file and then read the temporary file (SCR::Read) to get the YCP map. Additionally call SuSEFirewall functions to determine the firewall settings regarding remote access to the saned (service "sane-port" 6566/tcp,6566/udp).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.6. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dump the scanner settings to a single map. For use by autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.7. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all scanner settings from the first parameter. For use by autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.8. ModelItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of items from the database entries which is used for the SelectionBox in the SelectModelDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string filter_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - of model strings (manufacturer, model, backend, comment)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.9. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Something was committed to the system?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if system may have been modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.10. OverviewContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create the content for WizardHW::SetContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list< map< string, any > > - a list of maps with keys "id" : string = the identification of the device, "rich_descr" : string = RichText description of the device "table_descr" : list<string> = fields of the table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.11. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all scanner settings: - Check installed packages - Read or create the scanner database - Determine active scanners - Determine active backends - Try to autodetect USB and SCSI scanners and HP all-in-one USB and NETWORK scanners

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.12. RestartDetection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Restart the whole autodetection by calling all autodetection functions in the same order as during the initial Read(): DetermineActiveScanners results a new active_scanners map which is empty if nothing was detected or if DetermineActiveScanners fails. DetermineActiveBackends results a new active_backends list which is empty if nothing was detected or if DetermineActiveBackends fails. AutodetectScanners results a new autodetected_scanners map which is empty if nothing was detected or if AutodetectScanners fails. RestartDetection is called when the user restarts the detection in the OverviewDialog and if testing of an active scanner failed (see the TestBackend function). The result is that all information in the OverviewDialog is recreated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true in any case (errors result only empty maps or list).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.13. RunHpsetup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run hp-setup:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - false if hp-setup cannot be run and return true in any other case because there is no usable exit code of hp-setup (always zero even in case of error).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.14. SetupNetworkScanningConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup the network scanning config by calling a bash script which activates or deactivates the "net" backend and which writes into /etc/sane.d/net.conf, /etc/sane.d/saned.conf, and /etc/xinetd.d/sane-port and reloads or starts the xinetd dependig on whether it is running or not. Additionally call SuSEFirewall functions to commit changed firewall settings regarding remote access to the saned (service "sane-port" 6566/tcp,6566/udp).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.15. TestBackend

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Test the backend according to the specified backend_name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string backend_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.3.16. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write scanner settings: - Save the actual environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.1. active_backends

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Active backends: Determined at runtime via Scanner::DetermineActiveBackends() which calls the bash script "/usr/lib/YaST2/bin/determine_active_scanner_backends YCP" which outputs on stdout a YCP list of backends [ "The name of the backend", ... "" ] where the last list entry is an empty string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.2. active_scanners

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Active scanners: Determined at runtime via Scanner::DetermineActiveScanners() which calls the bash script "/usr/lib/YaST2/bin/determine_active_scanners YCP" which outputs on stdout a YCP list of @ref active_scanner_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                active_scanner_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "backend":"The name of the backend (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sane_device":"The SANE device (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "manufacturer":"The manufacturer name of the scanner (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "model":"The model name of the scanner (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.3. actual_environment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Environment values: It is a map of @ref environment_values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                environment_values
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "sane-backends_version":"What 'rpm -q sane-backends' returns (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "hplip_version":"What 'rpm -q hplip' returns (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "iscan_version":"What 'rpm -q iscan' returns (required)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "iscan-free_version":"What 'rpm -q iscan-free' returns (required)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.4. autodetected_scanners

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Autodetected scanners: Determined at runtime via Scanner::AutodetectScanners() which calls the bash script /usr/lib/YaST2/bin/autodetect_scanners YCP which calls "sane-find-scanner" and (if available) "hp-probe" which may result for example the description strings in the example below. Only in case of USB an automated extraction of manufacturer is possible. If there are two '[...]' substrings then the first one is the manufacturer and the second one is the model (but there may be only one or none substring). The result is a YCP list of @ref autodetected_scanner_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autodetected_scanner_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "connection":"Either USB or SCSI or NETWORK (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "device":"The device, e.g. '/dev/sg0' or 'libusb:001:002' (may be the empty string)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "manufacturer":"The manufacturer name of the scanner (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "usb_vendor_id":"The vendor ID (e.g. 0x04b8) of a USB scanner (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "model":"The model name of the scanner (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "usb_product_id":"The product ID (e.g. 0x010b) of a USB scanner (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "description":"The sane-find-scanner output description string (required)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.5. database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scanner database: When package version of sane-backends/hplip/iscan/iscan-free changes the database is created anew in Scanner::Read() which calls the bash script "/usr/lib/YaST2/bin/create_scanner_database YCP" which outputs on stdout a YCP list of @ref scanner_model_map where the last list entry is an emtpy map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scanner_model_map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "package":"The package which provides the backend: sane-backends/hplip/iscan/iscan-free (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "backend":"The name of the backend (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "manufacturer":"The manufacturer name of the scanner (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "model":"The model name of the scanner (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "firmware":"Whether or not firmware upload is required (value is 'required' or the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "interface":"None or one or more scanner interfaces (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "usbid":"USBvendorID:USBproductID" e.g. "0x0a1b:0x2c3d" (may be the empty string)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "status":"The support status: basic/complete/good/minimal/unsupported/untested (required)",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "comment":"An optional comment (may be the empty string)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.6. database_manufacturers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Manufacturer list: List of unique manufacturer names. Derived during startup from the scanner database (in the Read function stage "Read or create the scanner database").

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.7. database_usbids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Known USB scanner USB IDs list: List of known USB scanner USB vendor and product IDs. Derived during startup from the scanner database (in the Read function stage "Read or create the scanner database").

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.8. firewall_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Firewall network scanning configuration: Determined at runtime via Scanner::DetermineNetworkScanningConfig() which calls SuSEFirewall functions to fill the map @ref firewall_config except "ui_no_firewall_for_int" and "ui_deny_from_ext" which are the user settings in the dialog. The entries are such that "true" is the default, reasonable and intended setting.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                firewall_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "suse_firewall_used":"true if Suse Firewall and no other firewall is used",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "firewall_active":"true if Suse Firewall is actually running",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "no_firewall_for_int":"true if Suse Firewall does not potect the INT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ui_no_firewall_for_int":"true if user has set in dialog no Suse Firewall protection for INT",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "denied_from_ext":"true if saned access (sane-port 6566) is denied from EXT zone",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ui_deny_from_ext":"true if user has set in dialog to deny access from EXT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.9. ignore_unknown_USB_scanners

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Ignore unknown USB scanners: Whether or not unknown USB scanners should be ignored during AutodetectScanners. As there is no USB device class for scanners (they have the unspecific USB device class 255), sane-find-scanner can only do some best guess to determine if a USB device is a scanner or not. Therefore also other USB devices with the device class 255 are reported as possible USB scanners. Preset to true so that initially only scanners for which the USB IDs are known by SANE are shown. It changes to false (i.e. show all USB devices with the device class 255 as possible USB scanners) when the user explicitely requests a "Restart Detection" in the OverviewDialog. A second "Restart Detection" changes it back to true so that "Restart Detection" toggles it. The idea behind is that the user can simply "Restart Detection" as often as he likes until the result is o.k. for him because "Restart Detection" does not cause harm and it avoids a separated button or check-box to determine the autodetection behaviour which would require additional explanatory (complicated) help text about the whole stuff. Examples: Assume there is a known powered-off USB scanner and another USB device with class 255: Initially nothing is shown. After the first "Restart Detection" only the other USB device with class 255 is shown. This unexpected result makes the user think about what is wrong and he powers-on the scanner. After the second "Restart Detection" only the USB scanner is shown. Assume there is an unknown powered-off USB scanner and another USB device with class 255. Initially nothing is shown. After the first "Restart Detection" only the other USB device with class 255 is shown. This unexpected result makes the user think about what is wrong and he powers-on the scanner. After the second "Restart Detection" nothing is shown. A third "Restart Detection" shows both the USB scanner and the other USB device with class 255. This is the best possible result because it is not possible to show only the unknown USB scanner.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.10. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Something was committed to the system? True if system may have been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.11. network_scanning_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Network scanning configuration: Determined at runtime via Scanner::DetermineNetworkScanningConfig() which calls the bash script "/usr/lib/YaST2/bin/determine_network_scanner_config YCP" which outputs on stdout a YCP map @ref network_scanner_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                network_scanner_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 $[ "net_backend_hosts":"Comma seperated list of hosts in /etc/sane.d/net.conf",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "saned_hosts":"Comma seperated list of hosts or subnets in /etc/sane.d/saned.conf"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.12. number_chars

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Explicite listing of all alphanumeric ASCII characters. The reason is that in certain special locales for example [a-z] is not equivalent to "abcdefghijklmnopqrstuvwxyz" because in certain special languages the 'z' is not the last character in the alphabet, e.g. the Estonian alphabet ends with ... s ... z ... t u v w ... x y (non-ASCII characters omitted here) so that [a-z] would exclude t u v w x y in an Estonian locale. Therefore uppercase and lowercase characters are both explicitely listed to avoid any unexpected result e.g. of "tolower(uppercase_characters)".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.13. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.14. selected_autodetected_scanners_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Selected autodetected scanners index: The index in the autodetected scanners list (of autodetected scanner maps) for the model which was selected by the user in the OverviewDialog. Preset to -1 which indicates that no model is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.15. selected_model_database_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Selected model database index: The index in the scanner database list (of model maps) for the model which was selected by the user in the SelectModelDialog. Preset to -1 which indicates that no model is selected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.4.16. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                254.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255. Security

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Data for the security configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Export - Dump the security settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • GetModified - Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import - Get all security settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • PollAbort - Check for pending Abort press

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read - Read all security settings

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Write - Write all security settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - blah blah lahjk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Dump the security settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.3. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get all security settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.6. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.7. PollAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check for pending Abort press

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if pending abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Read all security settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.9. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Write all security settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.4.1. AbortFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.4.2. PasswordMaxLengths

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of sigificant characters in the password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.4.3. Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  All security settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.4.4. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Pam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • PamSettings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  255.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • security/levels.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  256. Sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Wizard Sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  256.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  256.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Run - The Wizard Sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    256.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    256.3.1. Run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The Wizard Sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map sequence

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol - final symbol or nil, if error (see the y2log)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    256.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    256.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    257. Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Service manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    257.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Petr Blahos <pblahos@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    257.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Adjust - Adjust runlevels in which the service runs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Disable - Disable service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Enable - Enable service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Enabled - Check if service is enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EnabledServices - Get list of enabled services in a runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Error - Error Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Find - Return the first of the list of services which is available (has init script) or "" if none is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Finetune - Set service to run in selected runlevels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FullInfo - Get service info and find out whether service is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Info - Get service info without peeking if service runs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Reload - Reload service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Restart - Restart service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RunInitScript - Run init script.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RunInitScriptWithTimeOut - Run init script with a time-out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Start - Start service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Status - Get service status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stop - Stop service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.1. Adjust

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Adjust runlevels in which the service runs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string action

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - success state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.2. Disable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Disable service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.3. Enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enable service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.4. Enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Check if service is enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if service is set to run in any runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.5. EnabledServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get list of enabled services in a runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer runlevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - enabled services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.6. Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Error Message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - error message from the last operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.7. Find

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return the first of the list of services which is available (has init script) or "" if none is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - the first found service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.8. Finetune

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set service to run in selected runlevels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list rl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - success state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.9. FullInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get service info and find out whether service is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - service map or empty map ($[])

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.10. Info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get service info without peeking if service runs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - Service information or empty map ($[])

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.11. Reload

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reload service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.12. Restart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Restart service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.13. RunInitScript

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Run init script.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string param

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer - exit value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.14. RunInitScriptWithTimeOut

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Run init script with a time-out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string param

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer - exit value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.15. Start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Start service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.16. Status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get service status.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer - init script exit status or -1 if it does not exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.3.17. Stop

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Stop service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if operation is successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      257.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      258. SignatureCheckCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      258.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Callbacks for handling signatures.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      258.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          258.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          258.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          258.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          258.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SignatureCheckDialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          258.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            259. SignatureCheckDialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            259.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Dialogs handling for RPM/Repository GPM signatures.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            259.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.1. CheckSignatures

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A semi-public helper. Convert the kernel parameter to the sysconfig string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - sysconfig value: yes, yast, no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.2. CheckSignaturesInYaST

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Should signatures be checked at all? Check a sysconfig variable (or a kernel parameter for the 1st installation stage).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - do checking?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.3. GetDefaultDialogReturn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function returns the default popup return value for case when user selected "don't show again"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.4. GetShowThisPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function returns whether user want's to show the dialog (again). true is the default if nothing is set.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - show the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.5. ImportGPGKeyDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ImportGPGKeyDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map<string,any> key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.6. ImportGPGKeyIntoTrustedDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ImportUntrustedGPGKeyIntoTrustedDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map<string,any> key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - whether zypp should import the key into the keyring of trusted keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.7. ItemSignedWithPublicSignature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used for file or package signed by a public key. This key is still not listed in trusted keys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol item_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string item_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map<string,any> key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol - `key_import, `install, `skip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.8. ItemSignedWithUnknownSignature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used for file or package signed by unknown key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol item_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string item_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string dont_show_dialog_ident

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer repoid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true if 'yes, use file'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.9. SetDefaultDialogReturn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function sets the default dialog return value for case when user selected "don't show again"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean default_return

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.10. SetShowThisPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Functions sets whether user want's to show the dialog again

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean show_it

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string popup_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.11. UseCorruptedItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used for corrupted file or package. Opens dialog asking whether user wants to use this corrupted item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol item_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string item_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map<string,any> key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - use or don't use ('true' if 'yes')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.12. UseFileWithUnknownDigest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Ask user to accept a file with unknown checksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string digest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string dont_show_dialog_ident

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true when user accepts the file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.13. UseFileWithWrongDigest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Ask user to accept wrong digest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string requested_digest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string found_digest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string dont_show_dialog_ident

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true when user accepts the file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.14. UseItemWithNoChecksum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used for file or package on signed repository but without any checksum. Opens dialog asking whether user wants to use this item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol item_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string item_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string dont_show_dialog_ident

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - use or don't use ('true' if 'yes')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.3.15. UseUnsignedItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used for unsiged file or package. Opens dialog asking whether user wants to use this unsigned item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol item_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string item_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string dont_show_dialog_ident

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - use or don't use ('true' if 'yes')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • DontShowAgain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              259.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                260. SlideShow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                260.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                260.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AppendMessageToInstLog - Append message to the installation log.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ChangeSlideIfNecessary - Check if the current slide needs to be changed and do that if necessary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CheckForSlides - Check if the slide show is available. This must be called before trying to access any slides; some late initialization is done here.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CloseDialog - Close the slide show dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CurrentStageDescription - Return the description for the current stage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GenericHandleInput - Check for user button presses and handle them. Generic handling to be used in the progress handlers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetSetup - Returns the current setup defined by Setup().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetUserAbort - Get the status of the flag that user requested abort of the installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GlobalProgressStart - Restart the global progress of the slideshow. This means the label will be set to \param text, value to 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HandleInput - Process (slide show) input (button press).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HaveSlideWidget - Check if the dialog is currently set up so the user could switch to the slide page.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • MoveToStage - Move the global progress to the beginning of the given stage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OpenDialog - Open the slide show dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • RebuildDialog - Rebuild the dialog. Useful if slides become available post-creating the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Reset - Initialize generic data to default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ResetTimer - Reset the internal (global) timer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetGlobalProgressLabel - Return the current global progress label.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetLanguage - Set the curent language. Must be called once during initialization.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetUserAbort - Set the flag that user requested abort of the installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Setup - Prepare the stages for the global progressbar. Will compute the total estimate of time and partition the global 100% to given stages based on their estimates. Can compute out of time and size to download.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ShowingDetails - Check if currently the "Details" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ShowingRelNotes - Check if currently the "Release Notes" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ShowingSlide - Check if currently the "Slide Show" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • StageProgress - Update the global progress according to the progress in the current stage. The new value will be set to the per cent of the current stage according to \param value.The value must be lower that 100 (or it's corrected to 100). If the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • StartTimer - Start the internal (global) timer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • StopTimer - Stop the internal (global) timer and account elapsed time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SubProgress - Update status of subprogress of the slideshow. The new value will be set to \param value, if the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SubProgressStart - Restart the subprogress of the slideshow. This means the label will be set to \param text, value to 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SwitchToDetailsView - Switch from the 'slide show' view to the 'details' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SwitchToReleaseNotesView - Switch to the 'release notes' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SwitchToSlideView - Switch from the 'details' view to the 'slide show' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TableItem - Create one single item for the CD statistics table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.1. AppendMessageToInstLog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Append message to the installation log.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string msg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.2. ChangeSlideIfNecessary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if the current slide needs to be changed and do that if necessary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.3. CheckForSlides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if the slide show is available. This must be called before trying to access any slides; some late initialization is done here.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.4. CloseDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Close the slide show dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.5. CurrentStageDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the description for the current stage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - localized string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.6. GenericHandleInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check for user button presses and handle them. Generic handling to be used in the progress handlers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.7. GetSetup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns the current setup defined by Setup().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map <string, map <string,any> > - stages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $[ stage_name : $[ stage_setup ], ... ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.8. GetUserAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the status of the flag that user requested abort of the installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - state of the abort requested flag (true = abort requested)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.9. GlobalProgressStart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restart the global progress of the slideshow. This means the label will be set to \param text, value to 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.10. HandleInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Process (slide show) input (button press).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any button

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.11. HaveSlideWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if the dialog is currently set up so the user could switch to the slide page.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.12. MoveToStage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Move the global progress to the beginning of the given stage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string stage_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.13. OpenDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Open the slide show dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.14. RebuildDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Rebuild the dialog. Useful if slides become available post-creating the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.15. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize generic data to default values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.16. ResetTimer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Reset the internal (global) timer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.17. SetGlobalProgressLabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the current global progress label.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void - current label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.18. SetLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the curent language. Must be called once during initialization.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string new_language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.19. SetUserAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the flag that user requested abort of the installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.20. Setup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Prepare the stages for the global progressbar. Will compute the total estimate of time and partition the global 100% to given stages based on their estimates. Can compute out of time and size to download.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list< map<string,any> > stages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.21. ShowingDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if currently the "Details" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if showing details, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.22. ShowingRelNotes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if currently the "Release Notes" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if showing details, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.23. ShowingSlide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Check if currently the "Slide Show" page is shown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if showing details, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.24. StageProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update the global progress according to the progress in the current stage. The new value will be set to the per cent of the current stage according to \param value.The value must be lower that 100 (or it's corrected to 100). If the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.25. StartTimer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Start the internal (global) timer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.26. StopTimer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Stop the internal (global) timer and account elapsed time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.27. SubProgress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update status of subprogress of the slideshow. The new value will be set to \param value, if the \text is not nil, the label will be updated to this text as well. Otherwise label will not change.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.28. SubProgressStart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Restart the subprogress of the slideshow. This means the label will be set to \param text, value to 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.29. SwitchToDetailsView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Switch from the 'slide show' view to the 'details' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.30. SwitchToReleaseNotesView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Switch to the 'release notes' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.31. SwitchToSlideView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Switch from the 'details' view to the 'slide show' view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.3.32. TableItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create one single item for the CD statistics table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string col1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string col2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string col3

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string col4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • term

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Slides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  260.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    261. SlideShowCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    261.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Purpose: provides the Callbacks for SlideShow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    261.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.1. CallbackSourceChange

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      change of repository source: 0 .. n-1 media: 1 .. n

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer media

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.2. DisplayStartInstall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Callback that will be called by the packager for each RPM as it is being installed or deleted. Note: The packager doesn't call this directly - the corresponding wrapper callbacks do and pass the "deleting" flag as appropriate.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string pkg_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string pkg_description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer pkg_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean deleting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.3. DonePackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at end of install just to override the PackageCallbacks default (which does a 'CloseDialog' :-})

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.4. DoneProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      during file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.5. FinishPatchDeltaProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at end of file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.6. InstallSlideShowCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Install callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.7. ProgressDeltaApply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      during file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.8. ProgressPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ProgressPackage percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer pkg_percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.9. ProgressProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      during file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.10. RemoveSlideShowCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove callbacks for slideshow. Should be in SlideShowCallbacks but that doesn't work at the moment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.11. StartDeltaApply

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at start of file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.12. StartDeltaProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at start of file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer archivesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.13. StartPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at start of package install

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer install_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean is_delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.14. StartPatchProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at start of file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer archivesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.3.15. StartProvide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      at start of file providal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer archivesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageCallbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageSlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      261.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        262. Slides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        262.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        262.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CheckBasePath - Check, if the base path set up for slides is valid (it exists and contains slides)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HaveSlideSupport - Check if showing slides is supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HaveSlides - Check if slides are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LoadSlideFile - Load one slide from files complete with image and textual description. Also adapt img links

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LoadSlides - Load slides for the given language and store them in the internal variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SetSlideDir - Set the slide show directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.1. CheckBasePath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check, if the base path set up for slides is valid (it exists and contains slides)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true, if it is possible to load the slides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.2. HaveSlideSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check if showing slides is supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if the current UI is capable of showing slides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.3. HaveSlides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Check if slides are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if the loaded list of slides contains any slides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.4. LoadSlideFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Load one slide from files complete with image and textual description. Also adapt img links

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string slide_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - true if OK, false if error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.5. LoadSlides

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Load slides for the given language and store them in the internal variables.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.3.6. SetSlideDir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set the slide show directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          262.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263. SlpServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SlpServer settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Zugec Michal <mzugec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Export - Dump the slp-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Import - Get all slp-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Read - Read all slp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Write - Write all slp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the slp-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all slp-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all slp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.9. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.3.10. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all slp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Confirm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NetworkService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCR
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            263.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • slp-server/helps.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264. Sound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sound data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Changed - Status of configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CollectOptions - this function converts options for modules from 'modules_conf' data structure to another - it is needed for writing options to /etc/modules conf. eg. we have these configured cards: [ $["model": "sblive", "module":"snd-emu10k1", "options" :$["opt1": "a", "opt2": "b"]], $["model": "sblive", "module":"snd-emu10k1", "options": $["opt2": "c"]], $["model": "other", "module":"mod2", "options": $["opt1": "a", "opt2": "b"]] ] CollectOptions ("snd-emu10k1") returns $["opt1":"a,", "opt2":"b,c"]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CreateModprobeCommands - creates list of command that will be used for sound system start (emulates 'rcalsasound start' somehow)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectHardware - do hardware detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DetectOldCards - Detect old ISA cards (which hwinfo doesn't know) using alsaconf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Export - Dump the sound settings to a single map. self explaining (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ForceReset - reset settings. used at installation time when user invokes 'reset to original proposal'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetJoystickSettings - Get joystick settings from sound database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetModified - Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetSoundCardList - returns list of configured/proposed sound cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetSoundCardListWithJoy - Return list of configured/proposed sound cards which support joystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HasJoystick - Test whether sound card supports joystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Import - Get all sound settings from the first parameter (For autoinstallation use.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • InitMixer - initialises volume after adding a new card. unmutes and sets volume for some channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • LoadDatabase - opens alsa sound cards database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • LoadPackageDatabase - opens alsa sound cards database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProbeOldChip - Probe one card with alsaconf call

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Propose - create a proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Read - Read all sound settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ReadModulesConf - searches for sound alias in /etc/modules.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RequiredKernelModules - Get list of all kernel modules which are requied by the configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RestoreSettings - restore settings from backup variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Set - Just Set module data

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetVolume - sets the channel volume to value [0..100]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Sound - sound module constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StoreMixer - store mixer settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StoreSettings - copy settings to backup variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StoreUniqueKeys - stores unique keys. this function is not part of sound_write module because it should not be called during autoinstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary - returns html formated configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpdateUnconfiguredCards - update list of unconfigured cards (necessary when deleting configured card)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Write - Update the SCR according to sound settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • getConfigurableCards - returns list of autodetected sound cards that haven't been already configured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • STRINGS - text constants for sound module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • card_id - id of current card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • configure_detected - When true: During autoinstallation, detected cards will be added automaticaly even if they are not defined in control file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • curr_driver - currently used card driver (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • curr_model - currently used card model (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • curr_vendor - currently used card vendor (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • db_indices -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • db_module_index -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • db_modules - module details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • db_vendors - map of card vendors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default_volume - default value of volume for new card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • detected_cards - list for storing detected cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • installation - flag for letting the module know, that it's launched from then hardware installation screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modules_conf - settings to save to /etc/modules.conf (only those concerning to sound)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modules_conf_b - backup structures for sound settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • proposal_created - was the proposal already generated?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • rc_vars - rc settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • removed_info - list for storing information about removed cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • save_entry - configuration map of current card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • skip_detection - Do not detect sounc cards, skip hardware probing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • unconfigured_cards - list of detected and unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • use_alsa - what sound system we're using (true=alsa, false=oss)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • use_ui - flag for showing/not showing ui stuff (eg when loading alsa database)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • used_modprobe_conf - This is true, if sound data were read from /etc/modprobe.conf On write, they shoud be removed and written only to /etc/modprobe.d/sound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • volume_settings - settings to save using .audio.alsa ... mixer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • write_only - write only mode? (-> do not restart services during writing)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.1. Changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Status of configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if configuration was changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.2. CollectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            this function converts options for modules from 'modules_conf' data structure to another - it is needed for writing options to /etc/modules conf. eg. we have these configured cards: [ $["model": "sblive", "module":"snd-emu10k1", "options" :$["opt1": "a", "opt2": "b"]], $["model": "sblive", "module":"snd-emu10k1", "options": $["opt2": "c"]], $["model": "other", "module":"mod2", "options": $["opt1": "a", "opt2": "b"]] ] CollectOptions ("snd-emu10k1") returns $["opt1":"a,", "opt2":"b,c"]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Map with collected options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.3. CreateModprobeCommands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            creates list of command that will be used for sound system start (emulates 'rcalsasound start' somehow)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - of shell commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.4. DetectHardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            do hardware detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success/failure

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.5. DetectOldCards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Detect old ISA cards (which hwinfo doesn't know) using alsaconf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.6. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the sound settings to a single map. self explaining (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.7. ForceReset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            reset settings. used at installation time when user invokes 'reset to original proposal'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.8. GetJoystickSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get joystick settings from sound database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - map with options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.9. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Functions which returns if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.10. GetSoundCardList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returns list of configured/proposed sound cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - of maps: [$["name": "ASDASD", "card_no": 0]...]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.11. GetSoundCardListWithJoy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return list of configured/proposed sound cards which support joystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - list of maps: [$["card_no":0, "name":"Sound Blaster Live!"]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.12. HasJoystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Test whether sound card supports joystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer c_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True if sound card c_id supports joystick

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.13. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all sound settings from the first parameter (For autoinstallation use.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.14. InitMixer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            initialises volume after adding a new card. unmutes and sets volume for some channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer c_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.15. LoadDatabase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            opens alsa sound cards database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean use_ui

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.16. LoadPackageDatabase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            opens alsa sound cards database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.17. ProbeOldChip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Probe one card with alsaconf call

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string chip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - non-empty string with card options when card is present

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.18. Propose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            create a proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success/failure

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.19. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all sound settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean interactive

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.20. ReadModulesConf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            searches for sound alias in /etc/modules.conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.21. RequiredKernelModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get list of all kernel modules which are requied by the configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - Unique list of modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.22. RestoreSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            restore settings from backup variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.23. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Just Set module data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.24. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.25. SetVolume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sets the channel volume to value [0..100]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer c_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.26. Sound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sound module constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.27. StoreMixer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            store mixer settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.28. StoreSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            copy settings to backup variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.29. StoreUniqueKeys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stores unique keys. this function is not part of sound_write module because it should not be called during autoinstallation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.30. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returns html formated configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Summary string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.31. UpdateUnconfiguredCards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            update list of unconfigured cards (necessary when deleting configured card)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.32. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update the SCR according to sound settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.3.33. getConfigurableCards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returns list of autodetected sound cards that haven't been already configured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> save_info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> - of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.1. STRINGS

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            text constants for sound module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.2. card_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            id of current card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.3. configure_detected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When true: During autoinstallation, detected cards will be added automaticaly even if they are not defined in control file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.4. curr_driver

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currently used card driver (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.5. curr_model

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currently used card model (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.6. curr_vendor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currently used card vendor (pointer to table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.7. db_indices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.8. db_module_index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.9. db_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            module details

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.10. db_vendors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            map of card vendors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.11. default_volume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            default value of volume for new card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.12. detected_cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            list for storing detected cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.13. installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flag for letting the module know, that it's launched from then hardware installation screen

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.14. modules_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            settings to save to /etc/modules.conf (only those concerning to sound)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.15. modules_conf_b

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            backup structures for sound settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.16. proposal_created

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            was the proposal already generated?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.17. rc_vars

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rc settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.18. removed_info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            list for storing information about removed cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.19. save_entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            configuration map of current card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.20. skip_detection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Do not detect sounc cards, skip hardware probing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.21. unconfigured_cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            list of detected and unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.22. use_alsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            what sound system we're using (true=alsa, false=oss)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.23. use_ui

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            flag for showing/not showing ui stuff (eg when loading alsa database)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.24. used_modprobe_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This is true, if sound data were read from /etc/modprobe.conf On write, they shoud be removed and written only to /etc/modprobe.d/sound

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.25. volume_settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            settings to save using .audio.alsa ... mixer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.4.26. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            write only mode? (-> do not restart services during writing)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Crash
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            264.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sound/read_routines.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sound/routines.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sound/texts.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            265. SourceDialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            265.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Gabriele Strattner <gs@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Stefan Schubert <schubi@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Cornelius Schumacher <cschum@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Purpose:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Displays possibilities to install from NFS, CD or partion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            265.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.1. EditDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sample implementation of URL selection dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.2. EditDialogProtocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sample implementation of URL selection dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string proto

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.3. EditDialogProtocolService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sample implementation of URL selection dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string proto

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.4. EditPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              URL editation popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - modified URL or empty string if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.5. EditPopupNoHTTPS

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              URL editation popup without the HTTPS option

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - modified URL or empty string if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.6. EditPopupService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              URL editation popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - modified URL or empty string if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.7. EditPopupType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              URL editation popup, allows setting plaindir type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean plaindir_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - modified URL or empty string if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.8. GetRepoName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return RepoName after the run of the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - the RepoName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.9. GetURL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return URL after the run of the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - the URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.10. SetRepoName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the RepoName to work with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string repo_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.11. SetURL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the URL to work with

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.12. SetURLType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the URL to work with, set the plaindir flag (type of the repository)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean plaindir_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.13. TypeDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sample implementation of URL type selection dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • symbol - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.14. TypeDialogDownloadOpt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Sample implementation of URL type selection dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map<string,any> - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.3.15. TypePopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              URL editation popup with the HTTPS option

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - modified URL or empty string if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CWM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • NetworkPopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SourceManager
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              265.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266. SourceManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SourceManager settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Status: Work in Progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AbortFunction - Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AddUpdateSources - Used by registration. This is really hairy because we simultaneously add them to zypp and ZENworks, but not if they are not signed. (thus being better than inst_source)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • AskForCD -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CommitSources - Commit changed repositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Export - Dump the repository-manager settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetSrcIdByIndex - Get Repository ID by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetSyncFlag - Return ZMD synchronization flag.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Import - Get all repository-manager settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InstInitSourceMoveDownloadArea - Finds the biggest temporary directory and uses it as packager download area.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InstallationSourceOnPartition - Function returns the partiton name which is used as a repository for the installation (IF any partition is used as a repository for installation, of course). Otherwise it returns an empty string "". See bugzilla #208222 for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Lock - Start a section where other processes (such as ZMD helpers) should not access the repository database. #170113 The calls may be nested.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Read - Read all source-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadSyncFlag - Read ZMD sync flag from the persistent store (/var/lib/YaST2/inst_source_config.ycp)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • RunCommandWithTimeout - Runs a bash command with timeout.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • RunDumbTimeout - Run - with a timeout - on dumb terminal to disable colors etc - using 'exit $?' because of buggy behavior '.background vs. ZMD' (FIXME still needed???)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetSyncFlag - Set ZMD synchronization flag.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetUrlByIndex - Set current used repository URL by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SourceData - Gather Repository Metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SyncAddedAndDeleted - Sync the changed repositories to ZENworks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SyncYaSTInstSourceWithZMD - Checks whether ZMD is running, starts it when isn't. Checks whether a ZYPP repository is listed in the ZMD services, adds one if it is missing. Everything is done via the .process agent with timeout (number in seconds).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Unlock - Other processes may access the repository database again

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Write - Write all repository-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • WriteSyncFlag - Write ZMD sync flag to the persistent store

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • createSource - Create a repository from an URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • deleteSourceByIndex - Delete Repository by the repository index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • deleteSourceBySrcId - Delete repository by Repository ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • deleteSourceByUrl - Delete Repository by repository URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • getSourceId - Get Repository ID when only URL is known

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.2. AbortFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Abort function return boolean return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.3. AddUpdateSources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Used by registration. This is really hairy because we simultaneously add them to zypp and ZENworks, but not if they are not signed. (thus being better than inst_source)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> urls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<string> - a list of added URLs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.4. AskForCD

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.5. CommitSources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Commit changed repositories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.6. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dump the repository-manager settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.7. GetSrcIdByIndex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get Repository ID by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer idx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.8. GetSyncFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return ZMD synchronization flag.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true/false = ZMD sync is enabled/disabled, nil = unknown (not configured/read)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.9. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all repository-manager settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.10. InstInitSourceMoveDownloadArea

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Finds the biggest temporary directory and uses it as packager download area.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.11. InstallationSourceOnPartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function returns the partiton name which is used as a repository for the installation (IF any partition is used as a repository for installation, of course). Otherwise it returns an empty string "". See bugzilla #208222 for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - partition name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.12. Lock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Start a section where other processes (such as ZMD helpers) should not access the repository database. #170113 The calls may be nested.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.13. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.14. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.15. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.16. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all source-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.17. ReadSyncFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read ZMD sync flag from the persistent store (/var/lib/YaST2/inst_source_config.ycp)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true = success, false = read/parse error or the file doesn't exist

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.18. RunCommandWithTimeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Runs a bash command with timeout.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string run_command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string log_command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer script_time_out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - with out, err and ret_code

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns map $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "exit" : int_return_code,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "stdout"  : [ "script", "stdout", "lines" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     "stderr"  : [ "script", "stderr", "lines" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.19. RunDumbTimeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run - with a timeout - on dumb terminal to disable colors etc - using 'exit $?' because of buggy behavior '.background vs. ZMD' (FIXME still needed???)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string log_command

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer seconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - with out, err and ret_code

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.20. SetSyncFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set ZMD synchronization flag.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean sync_enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.21. SetUrlByIndex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Set current used repository URL by index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer idx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.22. SourceData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Gather Repository Metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.23. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.24. SyncAddedAndDeleted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sync the changed repositories to ZENworks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<integer> added_src_ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<integer> deleted_src_ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.25. SyncYaSTInstSourceWithZMD

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checks whether ZMD is running, starts it when isn't. Checks whether a ZYPP repository is listed in the ZMD services, adds one if it is missing. Everything is done via the .process agent with timeout (number in seconds).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - whether the syncing succeeds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.26. Unlock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Other processes may access the repository database again

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.27. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write all repository-manager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.28. WriteSyncFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write ZMD sync flag to the persistent store

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true = success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.29. createSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a repository from an URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.30. deleteSourceByIndex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete Repository by the repository index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer idx

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.31. deleteSourceBySrcId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete repository by Repository ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer SrcId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.32. deleteSourceByUrl

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete Repository by repository URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.3.33. getSourceId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get Repository ID when only URL is known

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InstURL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                266.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  267. SourceManagerSLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SLP-related SourceManager settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  267.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Status: Work in Progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  267.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddSourceTypeSLP - Function scans for SLP installation servers on the network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SelectOneSLPService - Function searches the SLP services on the current network. If there are some SLP services, opens up a dialog containing them and user has to select one or cancel the operation. Selected URL is returned as string, otherwise a nil is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.3.1. AddSourceTypeSLP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function scans for SLP installation servers on the network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - one of `back, `next

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.3.2. SelectOneSLPService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function searches the SLP services on the current network. If there are some SLP services, opens up a dialog containing them and user has to select one or cancel the operation. Selected URL is returned as string, otherwise a nil is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - service_URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SLP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    267.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      268. SpaceCalculation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      268.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Klaus Kaempf (kkaempf@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Gabriele Strattner (gs@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stefan Schubert (schubi@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Purpose: Package installation functions usable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • when the installation media is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • on Installation::sourcedir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      268.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CheckDiskFreeSpace - Check, if there is enough free space after installing the current selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • EvaluateFreeSpace - Evaluate the free space on the file system. Runs the command "df" and creates a map containig information about used and free space on every partition. Free space is calculated respecting the spare_percentage given in second argument.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.3.1. CheckDiskFreeSpace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check, if there is enough free space after installing the current selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer free_percent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer max_unsufficient_free_size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map> - of partitions which have less than free_percent free size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.3.2. EvaluateFreeSpace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Evaluate the free space on the file system. Runs the command "df" and creates a map containig information about used and free space on every partition. Free space is calculated respecting the spare_percentage given in second argument.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer spare_percentage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map<string,any> > - partition list, e.g. [$["free":389318, "name":"/", "used":1487222], $["free":1974697, "name":"usr", "used":4227733]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 88. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         EvaluateFreeSpace ( 5 );
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ***  This is needed during update !


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        268.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          269. Squid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          269.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ACLIsUsedBy - Returns list of options which use this ACL (identified by id_item). It's necessary to run this function before deleting ACL to know if any options are not affected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Export - Dump the squid settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetHttpPortsOnly - Returns only list of configured ports (no hosts and so on)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Import - Get all squid settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IsServiceRunning - Returns true if Squid service is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NumACLs - Returns number of occurences of ACL (definition lines) in config file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • NumACLsByName - Same as NumACLs but ACL is identified by name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Read - Read all squid settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StartService - Start Squid service if not running otherwise reload. Returns true if squid was successfuly started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • StopService - Stop Squid service. Returns true if squid was successfuly stopped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Write - Write all squid settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.1. ACLIsUsedBy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of options which use this ACL (identified by id_item). It's necessary to run this function before deleting ACL to know if any options are not affected.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer id_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.2. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the squid settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.4. GetHttpPortsOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns only list of configured ports (no hosts and so on)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.5. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get all squid settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map sett

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.6. IsServiceRunning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns true if Squid service is running.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.7. NumACLs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns number of occurences of ACL (definition lines) in config file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer id_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.8. NumACLsByName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Same as NumACLs but ACL is identified by name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.9. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all squid settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.10. StartService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Start Squid service if not running otherwise reload. Returns true if squid was successfuly started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.11. StopService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stop Squid service. Returns true if squid was successfuly stopped

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.12. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.3.13. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all squid settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.4.1. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            269.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              270. SquidACL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              270.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                270.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetOptions - Returns values from widget as list of options in correct form to store them into Squid module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetTypesToComboBox - Returns list of terms in form: [ `item(`id(key), acl_map[key]["name"]:""), `item(... ) ] Returned list is preferably to place in UI::ComboBox as list of all available types of ACLs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InitWidget - Initialize widget of acl identified by id_acl_type. If id_item is not nil, function initialize widgets by default values from module Squid.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Replace - Replace widget with id widget_id by widget acl_map[id_acl_type]["widget"].

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SupportedACLs - Returns list of supported ACLs. It's necessary to have saved unsupported ACLs but do not handle with them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Verify - This function call verification function joined with acl type identified by id_acl_type. Returns return value of verification function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.1. GetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns values from widget as list of options in correct form to store them into Squid module.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string id_acl_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.2. GetTypesToComboBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns list of terms in form: [ `item(`id(key), acl_map[key]["name"]:""), `item(... ) ] Returned list is preferably to place in UI::ComboBox as list of all available types of ACLs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<term>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.3. InitWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize widget of acl identified by id_acl_type. If id_item is not nil, function initialize widgets by default values from module Squid.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string id_acl_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer id_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any help_widget_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.4. Replace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Replace widget with id widget_id by widget acl_map[id_acl_type]["widget"].

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any widget_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string id_acl_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.5. SupportedACLs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns list of supported ACLs. It's necessary to have saved unsupported ACLs but do not handle with them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.3.6. Verify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This function call verification function joined with acl type identified by id_acl_type. Returns return value of verification function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string id_acl_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  270.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    270.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • squid/SquidACL_local_functions.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    271. SquidErrorMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    271.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      271.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetLanguageFromPath - Inverse function to GetPath. Returns languge which has path pth to directory containing error messages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetLanguages - Returns list of all available languages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetLanguagesToComboBox - Returns list of all available languages in form of items of ComboBox.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetPath - Returns path to directory containing error messages in given language.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.3.1. GetLanguageFromPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inverse function to GetPath. Returns languge which has path pth to directory containing error messages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string pth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.3.2. GetLanguages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns list of all available languages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.3.3. GetLanguagesToComboBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns list of all available languages in form of items of ComboBox.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<term>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.3.4. GetPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns path to directory containing error messages in given language.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FileUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        271.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          272. Sshd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SSHD settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          272.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Representation of the configuration of SSHD.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Input and output routines.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          272.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Abort - Returns a confirmation popup dialog whether user wants to really abort.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - Exports the current configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetDefaultSSHDOption - Returns default SSHD Option as a list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetModified - Returns whether the configuration has been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetSSHDOption - Returns the SSHD Option as a list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import - Imports a configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PollAbort - Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read - Read all SSHD settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetModified - Sets that the configuration has been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetSSHDOption - Sets values for an option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Write all SSHD settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns a confirmation popup dialog whether user wants to really abort.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Exports the current configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - of a current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               "config" : (map <string, list<string> >) SETTINGS,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               "status" : (boolean) service_status,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.3. GetDefaultSSHDOption

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns default SSHD Option as a list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string option_key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - with option_values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.4. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether the configuration has been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.5. GetSSHDOption

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the SSHD Option as a list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string option_key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - with option_values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.6. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Imports a configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map import_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.7. PollAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if abort confirmed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all SSHD settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.9. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets that the configuration has been modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.10. SetSSHDOption

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets values for an option.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string option_key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> option_vals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all SSHD settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SCR
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            272.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              273. SshdCommandLine

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              SSHD CommandLine functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              273.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CommandLine functions for SSHD Configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              273.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  273.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  273.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  273.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  273.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • CommandLine
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Sshd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  273.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    274. Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Installation mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    274.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    274.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Set - Set the installation stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • cont - continuing installation in target system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • firstboot - Firstboot stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • initial - starting installation in inst-sys system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • normal - normal, running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • reprobe - This flag indicates that a config module has been called due to a change in the system hardware that has been detected on boot time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • stage - Get the current stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.1. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the installation stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string new_stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.2. cont

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      continuing installation in target system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if installation continues on the target system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.3. firstboot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Firstboot stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if first-boot installation is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.4. initial

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      starting installation in inst-sys system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if installation first stage is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.5. normal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      normal, running system

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if YaST was started normally

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.6. reprobe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This flag indicates that a config module has been called due to a change in the system hardware that has been detected on boot time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if YaST was invoked because new hardware was probed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.3.7. stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the current stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - the current stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      274.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      275. Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      275.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Johannes Buchhold (jbuch@suse.de)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Purpose: These module contains all settings/information which

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • are needed to partitioning the harddisk. Futhermore it contains a interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • to * access and modify the partitioning settings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Todo: Translate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Diese Modul enthält alle Informationen die für die Partitionierung der

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Festplatten erforderlich sind. Diese Informationen bestehen aus der

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Beschreibung, der vor der Partitionierung vorhandenen Platteneinstellungen,

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • und der Art und Weise wie diese verändert werden soll.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Alle nötigen Zugriffsfunktionen auf diese Datenstruktur sind ebenfalls in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • diesem Modul enthalten. Der Zugriff auf die Speicherung der

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Partitionseinstellungen läuft also nur über dieses Modul.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Der Zugriff und die Rückgabe von Teilen der Partitionsdatenstruktur

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • wurde versucht "intelligent" zu gestallten und ist im einzelen bei den

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • entspechenden Funktionen näher erklärt.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      275.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.1. AddFstabEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Adds an entry into the fstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map e

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer - (0 and higher == OK, otherwise error)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.2. AddMountPointInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Adds mountpoint info to the target map and returns the changed map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> - target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.3. AddSwapMp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mark swap-partitions with pseudo Mountpoint swap in targetMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> - modified target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.4. AddWinInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Adds ... and returns the changed map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> targets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> - targets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.5. CheckForLvmRootFs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CheckForLvmRootFs --------------------------------------------------------------------- check if the root filesystem is a lvm logical volume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.6. CheckSwapOn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check if swap paritition is availbe on a disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if swap available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.7. CommitChanges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Apply storage changes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.8. CreatePartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Creates a new partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol ptype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer len

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol mby

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.9. DeletePartitionTable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete the partition table and disk label of device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer size_k

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.10. DetectFs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Detects a filesystem on a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol - filesystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.11. GetDeviceName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Device Name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • any partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - device name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example 89. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Storage::GetDeviceName ("/dev/md", 1)


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.12. GetDisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns disk identified by 'device' taken from the 'tg' (target) map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> tg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.13. GetDiskPartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns map describing the disk partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - DiskPartition Examples: "/dev/sda" -> $[ "disk" : "/dev/sda", "nr" : "" ] "/dev/sda2" -> $[ "disk" : "/dev/sda", "nr" : 2 ] "/dev/system" -> $[ "disk" : "/dev/system", "nr" : "" ] "/dev/system/abuild" -> $[ "disk" : "/dev/system", "nr" : "abuild" ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.14. GetFreeSpace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns map of free space per partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer testsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol used_fs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean verbose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.15. GetMountPoints

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GetMountPoints() collect mountpoint:device as map to get a sorted list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - of lists, the map key is the mount point, usually starting with a "/". Exception is "swap" For directory mount points (key starting with /) the value is a list [partitionName, fsid, targetdevice, raid_type] For swap mount points, the value is a list of lists: [[partitionName, fsid, targetdevice, raid_type], ...]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.16. GetOndiskTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns map describing the disk target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map< string, map >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.17. GetOtherLinuxPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get list of all Linux Partitions on all real disks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - Partition list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.18. GetPrimPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns list of primary partitions found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> targets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean foreign_os

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - of primary partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.19. GetTargetMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns a system target map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, map> - target map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ... ?
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.20. HandleProposalPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Takes care of selecting packages needed by storage in installation (replacement for HandlePackages in *_proposal clients)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.21. InitializeDisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the flag if a disk needs to be initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.22. IsPartitionable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Checks if a container is partitionable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if partitionable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entry ~ $[ "type" : ... ? ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.23. IsRealDisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check if a disk is a real disk and not RAID or LVM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if real disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entry ~ $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           "type":`CT_DISK,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           "driver" : "?",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           "readonly" : false / true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.24. IsResizable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether a partition is resizable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map part

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - resizable ?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.25. Mount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Mounts a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string mp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Umount()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.26. MountOpt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Mounts a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string mp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string fstopt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Umount()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.27. ReReadTargetMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Rereads the system target map and returns it

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, map> - target map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetTargetMap();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.28. ReadFstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Reads and returns fstab from directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.29. RemoveDmMapsTo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Removes ... maps to ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.30. ResizePartition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets a new size for volume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer new_cyls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successfull

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.31. ResizeVolume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets a new size for volume

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer new_size_k

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successfull

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.32. SetPartitionData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set <key> in partition <device> to the given <value> and return changed map <tg>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> tg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • any value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,map> - changed target map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.33. SetPartitionFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets whether a partition should be formatted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean format

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol fs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.34. SetPartitionId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets partition ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • integer id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • UnchangePartitionId()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.35. SetPartitionMount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Sets a mountpoint for partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string mp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.36. SwappingPartitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get List of swap partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - List of swap partitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.37. Umount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Umounts a device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string dev

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mount()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.38. UnchangePartitionId

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Restores the original partition ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - if succesful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SetPartitionId()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.39. Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates fstab on disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map oldv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map newv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           // This means version 9.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           "major" : 9,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           "minor" : 1,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.40. UpdateTargetMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Updates target map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetTargetMap()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.41. WriteFstab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Writes fstab to the disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.3.42. getDiskInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns map with disk info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - disk info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Encoding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Hotplug
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::CommitInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::ContainerInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DiskInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmPartCoInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmPartInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmmultipathCoInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmmultipathInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmraidCoInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::DmraidInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::LoopInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::LvmLvInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::LvmVgInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::MdInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::NfsInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::PartitionAddInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::PartitionInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::PartitionSlotInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::StorageInterface
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • LibStorage::VolumeInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackagesProposal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Region
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StorageClients
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • StorageDevices
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        275.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          276. StorageClients

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          276.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Thomas Fehr <fehr@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Purpose: Define callbacks for libstorage.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          276.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              276.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              276.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              276.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              276.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SlideShow
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • StorageCallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              276.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                277. StorageControllers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                277.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Klaus Kaempf <kkaempf@suse.de> (initial)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Purpose:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • This module does all floppy disk related stuff:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • - Detect the floppy devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SCR: Read(.probe.storage)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                277.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.3.1. Initialize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void - Init storage controllers (module loading) Must have called StorageControllers::probe() before ! // O: list of [ loaded modules, module argument ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.3.2. Probe

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Probe storage controllers probing, loading modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer - number of controllers, 0 = none found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.3.3. StartHotplugStorage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Start storage related USB and FireWire stuff

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Hotplug
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • HwStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Initrd
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Kernel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ModuleLoading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ModulesConf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Storage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • StorageClients
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • StorageDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  277.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    278. StorageDevices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This module does all storage device related stuff: - hard disk drives - removable drives (ZIP) - floppy devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    278.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Klaus Kaempf <kkaempf@suse.de> (initial)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    278.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        278.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        278.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        278.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        278.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AsciiFile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • HwStatus
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Kernel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        278.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          279. StorageFields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          279.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          279.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • IterateTargetMap - Call callback for every disk of target_map in a well defined sorted order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OverviewContents - The device must be the device entry in the target-map, e.g. "/dev/sda1", not something like "LABEL=test".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PredicateAll - Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PredicateDevice - Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PredicateDiskDevice - Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PredicateDiskType - Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • PredicateUsedByDevice - Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TableContents - The predicate function determines whether the disk/partition is included. The predicate function takes two arguments, disk and partition. For disks predicate is called with the partitions set to nil.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.1. IterateTargetMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Call callback for every disk of target_map in a well defined sorted order.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map> target_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.2. OverviewContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The device must be the device entry in the target-map, e.g. "/dev/sda1", not something like "LABEL=test".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<symbol> fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map> target_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.3. PredicateAll

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.4. PredicateDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.5. PredicateDiskDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> disk_devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.6. PredicateDiskType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<symbol> disk_types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.7. PredicateUsedByDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Predicate function for Table and TableContents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.3.8. TableContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The predicate function determines whether the disk/partition is included. The predicate function takes two arguments, disk and partition. For disks predicate is called with the partitions set to nil.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<symbol> fields

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, map> target_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<term>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileSystems
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            279.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              280. StorageSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              280.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              280.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  280.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  280.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  280.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  280.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Partitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Storage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  280.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    281. String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    String manipulation routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    281.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    281.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CAlnum - The 62 upper and lowercase ASCII letters and digits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CAlpha - The 52 upper and lowercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CDigit - Digits: 0123456789

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CGraph - Printable ASCII charcters except whitespace, 33-126

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CLower - The 26 lowercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CPrint - Printable ASCII characters including whitespace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CPunct - The ASCII printable non-blank non-alphanumeric characters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CSpace - ASCII whitespace: SPACE CR LF HT VT FF

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CUpper - The 26 uppercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CXdigit - Hexadecimal digits: 0123456789ABCDEFabcdef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CutBlanks - Remove blanks at begin and end of input string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CutRegexMatch - Remove first or every match of given regular expression from a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CutZeros - Remove any leading zeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EscapeTags - Function for escaping (replacing) (HTML|XML...) tags with their (HTML|XML...) meaning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FirstChunk - Shorthand for select (splitstring (s, separators), 0, "") Useful now that the above produces a deprecation warning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatFilename - Format file name - truncate the middle part of the directory to fit to the reqested lenght. Path elements in the middle of the string are replaced by ellipsis (...). The result migth be longer that requested size if size of the last element (with ellipsis) is longer than the requested size. If the requested size is greater than size of the input then the string is not modified. The last part (file name) is never removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatRate - Return a pretty description of a download rate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatRateMessage - Add a download rate status to a message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatSize - Return a pretty description of a byte count

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatSizeWithPrecision - Return a pretty description of a byte count

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetCommentLines - Get comment without metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetMetaDataLines - Get metadata lines from input string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NewlineItems -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • NonEmpty -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptFormat - Optional formatted text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptParens - Optional parenthesized text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Pad - Add spaces after the text to make it long enough

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • PadZeros - Add zeros before the text to make it long enough.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ParseOptions - Parse string of values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ParseSysconfigComment - Parse metadata from a sysconfig comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Quote - Quote a string with 's

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Random - Make a random base-36 number. srandom should be called beforehand.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Replace - Replace substring in a string. All substrings source are replaced by string target.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TextTable - Function creates text table without using HTML tags. (Useful for commandline) Undefined option uses the default one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UnQuote - Unquote a string with 's (quoted with quote)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UnderlinedHeader - Function returns underlined text header without using HTML tags. (Useful for commandline)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ValidCharsFilename - Characters valid in a filename (not pathname). Naturally "/" is disallowed. Otherwise, the graphical ASCII characters are allowed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • WrapAt - Returns text wrapped at defined margin. Very useful for translated strings used for pop-up windows or dialogs where you can't know the width. It controls the maximum width of the string so the text should allways fit into the minimal ncurses window. If you expect some long words, such us URLs or words with a hyphen inside, you can also set the additional split-characters to "/-". Then the function can wrap the word also after these characters. This function description was wrapped using the function String::WrapAt().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.1. CAlnum

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The 62 upper and lowercase ASCII letters and digits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.2. CAlpha

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The 52 upper and lowercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.3. CDigit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Digits: 0123456789

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.4. CGraph

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Printable ASCII charcters except whitespace, 33-126

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.5. CLower

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The 26 lowercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.6. CPrint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Printable ASCII characters including whitespace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.7. CPunct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The ASCII printable non-blank non-alphanumeric characters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.8. CSpace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ASCII whitespace: SPACE CR LF HT VT FF

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.9. CUpper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The 26 uppercase ASCII letters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.10. CXdigit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hexadecimal digits: 0123456789ABCDEFabcdef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.11. CutBlanks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove blanks at begin and end of input string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - stripped string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 90. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       CutBlanks("  any  input     ") -> "any  input"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.12. CutRegexMatch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove first or every match of given regular expression from a string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string regex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean glob

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - that has matches removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.13. CutZeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Remove any leading zeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - that has leading zeros removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.14. EscapeTags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for escaping (replacing) (HTML|XML...) tags with their (HTML|XML...) meaning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - escaped text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.15. FirstChunk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Shorthand for select (splitstring (s, separators), 0, "") Useful now that the above produces a deprecation warning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string separators

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - first component or ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.16. FormatFilename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Format file name - truncate the middle part of the directory to fit to the reqested lenght. Path elements in the middle of the string are replaced by ellipsis (...). The result migth be longer that requested size if size of the last element (with ellipsis) is longer than the requested size. If the requested size is greater than size of the input then the string is not modified. The last part (file name) is never removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string file_path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer len

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - Truncated file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 91. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatFilename("/really/very/long/file/name", 15) -> "/.../file/name"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatFilename("/really/very/long/file/name", 5) -> ".../name"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatFilename("/really/very/long/file/name", 100) -> "/really/very/long/file/name"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.17. FormatRate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a pretty description of a download rate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer bytes_per_second

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - formatted string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 92. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatRate(6780) -> ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatRate(0) -> ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatRate(895321) -> ""


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.18. FormatRateMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add a download rate status to a message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer avg_bps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer curr_bps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - formatted message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.19. FormatSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a pretty description of a byte count

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer bytes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - formatted string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 93. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatSize(23456767890) -> "223.70 MB"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.20. FormatSizeWithPrecision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return a pretty description of a byte count

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer bytes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer precision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean omit_zeroes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - formatted string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 94. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatSizeWithPrecision(128, 2, true) -> "128 B"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatSizeWithPrecision(4096, 2, true) -> "4 kB"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatSizeWithPrecision(4096, 2, false) -> "4.00 kB"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       FormatSizeWithPrecision(1024*1024, 2, true) -> "1 MB"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.21. GetCommentLines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get comment without metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - Comment used as variable description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.22. GetMetaDataLines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get metadata lines from input string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - Metadata lines in list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.23. NewlineItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - the items as a list, with empty lines removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.24. NonEmpty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> l

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - only non-"" items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.25. OptFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional formatted text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string f

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - sformat (f, s) if s is neither empty or nil, else ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.26. OptParens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parenthesized text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - " (Foo)" if Foo is neither empty or nil, else ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.27. Pad

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add spaces after the text to make it long enough

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - padded text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.28. PadZeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Add zeros before the text to make it long enough.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - padded text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.29. ParseOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parse string of values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - List of strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.30. ParseSysconfigComment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parse metadata from a sysconfig comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map<string, string> - parsed metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.31. Quote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Quote a string with 's

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string var

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - quoted string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 95. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       quote("a'b") -> "a'\''b"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.32. Random

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Make a random base-36 number. srandom should be called beforehand.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer len

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - random string of 0-9 and a-z

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.33. Replace

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Replace substring in a string. All substrings source are replaced by string target.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string target

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.34. TextTable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function creates text table without using HTML tags. (Useful for commandline) Undefined option uses the default one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <list <string> > items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - table Header: [ "Id", "Configuration", "Device" ] Items: [ [ "1", "aaa", "Samsung Calex" ], [ "2", "bbb", "Trivial Trinitron" ] ] Possible Options: horizontal_padding (for columns), table_left_padding (for table)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.35. UnQuote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Unquote a string with 's (quoted with quote)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string var

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - unquoted string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • quote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.36. UnderlinedHeader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns underlined text header without using HTML tags. (Useful for commandline)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string header_line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer left_padding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - underlined header line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.37. ValidCharsFilename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Characters valid in a filename (not pathname). Naturally "/" is disallowed. Otherwise, the graphical ASCII characters are allowed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - for ValidChars

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.3.38. WrapAt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns text wrapped at defined margin. Very useful for translated strings used for pop-up windows or dialogs where you can't know the width. It controls the maximum width of the string so the text should allways fit into the minimal ncurses window. If you expect some long words, such us URLs or words with a hyphen inside, you can also set the additional split-characters to "/-". Then the function can wrap the word also after these characters. This function description was wrapped using the function String::WrapAt().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer width

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string split_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - wrapped string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 96. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       String::WrapAt("Some very long text",30,"/-");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      281.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282. SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface manipulation of /etc/sysconfig/SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ActivateConfiguration - Function which stops firewall. Then firewall is started immediately when firewall is wanted to be started: SetStartService(boolean).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AddForwardIntoMasqueradeRule - Adds forward into masquerade rule.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AddInterfaceIntoZone - Functions adds interface into defined zone. All appearances of interface in other zones are removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AddService - Function adds service into selected zone (or zone of interface) for selected protocol. Function take care about port-aliases, first of all, removes all of them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AddSpecialInterfaceIntoZone - Functions adds special string into defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AddXenSupport - Function adds a special interface 'xenbr+' into the FW_FORWARD_ALWAYS_INOUT_DEV variable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ConvertToServicesDefinedByPackages - Converts old built-in service definitions to services defined by packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • DisableServices - Functions disables services needed for SuSEFirewall in /etc/inet.d/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • EnableServices - Functions enables services needed for SuSEFirewall in /etc/inet.d/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export - Function for getting exported SuSEFirewall configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAcceptExpertRules - Returns list of rules describing protocols and ports that are allowed to be accessed from listed hosts. All is returned as a single string. Zone needs to be defined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAdditionalServices - This powerful function returns list of services/ports which are not assigned to any fully-supported known-services. This function doesn't check for services defined by packages. They are listed by a different way.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAllDialUpInterfaces - Function returns list of dial-up interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAllKnownInterfaces - Function returns list of maps of known interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAllNonDialUpInterfaces - Function returns list of non-dial-up interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetBroadcastAllowedPorts - Local function return map of allowed ports (without aliases). If any list for zone is defined but empty, all allowed UDP ports for this zone also accept broadcast packets. This function returns only ports that are mentioned in configuration, it doesn't return ports that are listed in some service (defined by package) which is enabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetEnableService - Function which returns whether SuSEfirewall should be enabled in /etc/init.d/ starting scripts during the Write() process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetFirewallInterfaces - Function returns all interfaces already configured in firewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetFirewallInterfacesMap - Function returns map of `interfaces in zones`.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetFirewallKernelModules - Returns list of additional kernel modules, that are loaded by firewall on startup. For instance "ip_conntrack_ftp" and "ip_nat_ftp" for FTP service.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetIgnoreLoggingBroadcast - Function returns yes/no - ingoring broadcast for zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetInterfacesInZone - Function returns list of known interfaces in requested zone. Special strings like 'any' or 'auto' and unknown interfaces are removed from list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetInterfacesInZoneSupportingAnyFeature - Function returns list of known interfaces in requested zone. Special string 'any' in EXT zone covers all interfaces without any zone assignment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetKnownFirewallZones - Function returns list of known firewall zones (shortnames)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetListOfForwardsIntoMasquerade - Function returns list of rules of forwarding ports to masqueraded IPs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetListOfKnownInterfaces - Function returns list of all known interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetLoggingSettings - Function returns actual state of logging for rule taken as parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetMasquerade - Function returns actual state of Masquerading support.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetModified - Functions returns whether any firewall's configuration was modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetProtectFromInternalZone - Function returns if firewall is protected from internal zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetProtocolTranslatedName - Returns translated protocol name. Translation is provided from SuSEfirewall2 sysconfig format to l10n format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServices - Function returns map of supported services in all firewall zones.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServicesAcceptRelated - Returns list of FW_SERVICES_ACCEPT_RELATED_*: Services to allow that are considered RELATED by the connection tracking engine, e.g., SLP browsing reply or Samba browsing reply.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServicesInZones - Function returns map of supported services all network interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetSpecialInterfacesInZone - Function returns list of special strings like 'any' or 'auto' and uknown interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetStartService - Function which returns if SuSEfirewall2 should start in Write process. In fact it means that SuSEfirewall2 will at the end.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetSupportRoute - Function returns if firewall supports routing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetTrustIPsecAs - Function returns the trust level of IPsec packets. See SetTrustIPsecAs() for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetZoneFullName - Function returns localized name of the zone identified by zone shortname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetZoneOfInterface - Function returns the firewall zone of interface, nil if no zone includes the interface. Error is reported when interface is found in multiple firewall zones, then the first appearance is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetZonesOfInterfaces - Function returns list of zones of requested interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetZonesOfInterfacesWithAnyFeatureSupported - Function returns list of zones of requested interfaces. Special string 'any' in 'EXT' zone is supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • HaveService - Function returns if requested service is allowed in respective zone. Function takes care for service's aliases (only for TCP and UDP). Service is defined by set of parameters such as port and protocol.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import - Function for setting SuSEFirewall configuration from input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • InterfacesSupportedByAnyFeature - Returns list of interfaces not mentioned in any zone and covered by the special string 'any' in zone 'EXT' if such string exists there and the zone is EXT. If the feature 'any' is not set, function returns empty list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsAnyNetworkInterfaceSupported - Function returns whether the feature 'any' network interface is supported in the firewall configuration. The string 'any' must be in the 'EXT' zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsEnabled - Function determines if all SuSEFirewall scripts are enabled in init scripts /etc/init.d/ now. For configuration "enabled" status use GetEnableService().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsInterfaceInZone - Function returns if the interface is in zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsOtherFirewallRunning - Function returns if any other firewall then SuSEfirewall2 is currently running on the system. It uses command `iptables` to get information about just active iptables rules and compares the output with current status of SuSEfirewall2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsServiceSupportedInZone - Function returns if service is supported (allowed) in zone. Service must be defined in the SuSEFirewallServices. Works transparently also with services defined by packages. Such service starts with "service:" prefix.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsStarted - Function determines if at least one SuSEFirewall script is started now. For configuration "started" status use GetStartService().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read - Function for reading SuSEFirewall configuration. Fills internal variables only.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoveForwardIntoMasqueradeRule - Function removes rule for forwarding into masquerade from the list of current rules returned by GetListOfForwardsIntoMasquerade().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoveInterfaceFromZone - Function removes interface from defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoveService - Function removes service from selected zone (or for interface) for selected protocol. Function takes care about port-aliases, removes all of them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RemoveSpecialInterfaceFromZone - Function removes special string from defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ResetModified - Do not use this function. Only for firewall installation proposal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ResetReadFlag - Function resets flag which doesn't allow to read configuration from disk again. So you actually can reread the configuration from disk. Currently, only the first Read() call reads the configuration from disk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SaveAndRestartService - Function for saving configuration and restarting firewall. Is is the same as Write() but write is allways forced.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetAcceptExpertRules - Sets expert allow rules for zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetAdditionalServices - Function sets additional ports/services from taken list. Firstly, all additional services are removed also with their aliases. Secondly new ports/protocols are added. It uses GetAdditionalServices() function to get the current state and then it removes what has been removed and adds what has been added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetBroadcastAllowedPorts - Function creates allowed-broadcast-ports string from broadcast map and saves it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetEnableService - Function which sets if SuSEfirewall should start in Write process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetFirewallKernelModules - Sets list of additional kernel modules to be loaded by firewall on startup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetIgnoreLoggingBroadcast - Function sets yes/no - ingoring broadcast for zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetInstallPackagesIfMissing - By default SuSEfirewall2 packages are just checked whether they are installed. With this function, you can change the behavior to also offer installing the packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetLoggingSettings - Function sets state of logging for rule taken as parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetMasquerade - Function sets Masquerade support.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetModified - Function sets internal variable, which indicates, that any "firewall settings were modified", to "true".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetProtectFromInternalZone - Function sets if firewall should be protected from internal zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetServices - Function sets status for several services on several network interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetServicesAcceptRelated - Functions sets FW_SERVICES_ACCEPT_RELATED_*: Services to allow that are considered RELATED by the connection tracking engine, e.g., SLP browsing reply or Samba browsing reply.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetServicesForZones - Function sets status for several services in several firewall zones.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetStartService - Function which sets if SuSEfirewall should start in Write process.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetSupportRoute - Function sets if firewall should support routing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetTrustIPsecAs - Function sets how firewall should trust successfully decrypted IPsec packets. It should be the zone name (shortname) or 'no' to trust packets the same as firewall trusts the zone from which IPsec packet came.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • StartServices - Functions starts services needed for SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • StopServices - Functions stops services needed for SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SuSEFirewallIsInstalled - Returns whether all needed packages are installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Write - Function for writing and enabling configuration it is an union of WriteConfiguration() and ActivateConfiguration().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • WriteConfiguration - Function writes configuration into /etc/sysconfig/ and enables or disables firewall in /etc/init.d/ by the setting SetEnableService(boolean). This is a write-only configuration, firewall is never started only enabled or disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • WriteOnly - Helper function for the backward compatibility. See WriteConfiguration(). Remove from code ASAP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.1. ActivateConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function which stops firewall. Then firewall is started immediately when firewall is wanted to be started: SetStartService(boolean).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.2. AddForwardIntoMasqueradeRule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Adds forward into masquerade rule.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string source_net

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string forward_to_ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string req_port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string redirect_to_port

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string requested_ip

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 97. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	AddForwardIntoMasqueradeRule ("0/0", "192.168.32.1", "TCP", "80", "8080", "10.0.0.1")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.3. AddInterfaceIntoZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions adds interface into defined zone. All appearances of interface in other zones are removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 98. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       AddInterfaceIntoZone ("eth5", "DMZ")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.4. AddService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function adds service into selected zone (or zone of interface) for selected protocol. Function take care about port-aliases, first of all, removes all of them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 99. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	AddService ("ssh", "TCP", "EXT")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	AddService ("ssh", "TCP", "dsl0")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.5. AddSpecialInterfaceIntoZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions adds special string into defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.6. AddXenSupport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function adds a special interface 'xenbr+' into the FW_FORWARD_ALWAYS_INOUT_DEV variable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • https://bugzilla.novell.com/show_bug.cgi?id=154133

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • https://bugzilla.novell.com/show_bug.cgi?id=233934

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • https://bugzilla.novell.com/show_bug.cgi?id=375482

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.7. ConvertToServicesDefinedByPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Converts old built-in service definitions to services defined by packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • #bnc 399217

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.8. DisableServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions disables services needed for SuSEFirewall in /etc/inet.d/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.9. EnableServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions enables services needed for SuSEFirewall in /etc/inet.d/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.10. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for getting exported SuSEFirewall configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> - with configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.11. GetAcceptExpertRules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns list of rules describing protocols and ports that are allowed to be accessed from listed hosts. All is returned as a single string. Zone needs to be defined.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - with rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.12. GetAdditionalServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This powerful function returns list of services/ports which are not assigned to any fully-supported known-services. This function doesn't check for services defined by packages. They are listed by a different way.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of additional (unassigned) services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 100. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetAdditionalServices("TCP", "EXT") -> ["53", "128"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.13. GetAllDialUpInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of dial-up interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of dial-up interface names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 101. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetAllDialUpInterfaces() -> ["modem0", "dsl5"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.14. GetAllKnownInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of maps of known interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <map <string, string> > - of all interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [ $[ "id":"modem0", "name":"Askey 815C", "type":"dialup", "zone":"EXT" ], ... ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.15. GetAllNonDialUpInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of non-dial-up interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of non-dial-up interface names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 102. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetAllNonDialUpInterfaces() -> ["eth1", "eth2"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.16. GetBroadcastAllowedPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Local function return map of allowed ports (without aliases). If any list for zone is defined but empty, all allowed UDP ports for this zone also accept broadcast packets. This function returns only ports that are mentioned in configuration, it doesn't return ports that are listed in some service (defined by package) which is enabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, list <string> > - strings are allowed ports or port ranges

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "ZONE1" : [ "port1", "port2" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "ZONE2" : [ "port3", "port4" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "ZONE3" : [ ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.17. GetEnableService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function which returns whether SuSEfirewall should be enabled in /etc/init.d/ starting scripts during the Write() process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if the firewall should start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Write()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • EnableServices()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.18. GetFirewallInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns all interfaces already configured in firewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - of configured interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.19. GetFirewallInterfacesMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns map of `interfaces in zones`.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, list <string> > - interface in zones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      map $[zone : [list of interfaces]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 103. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetFirewallInterfacesMap() -> $["DMZ":[], "EXT":["dsl0"], "INT":["eth1", "eth2"]]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.20. GetFirewallKernelModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns list of additional kernel modules, that are loaded by firewall on startup. For instance "ip_conntrack_ftp" and "ip_nat_ftp" for FTP service.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of kernel modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • /etc/sysconfig/SuSEfirewall2 option nr. 32 (FW_LOAD_MODULES)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.21. GetIgnoreLoggingBroadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns yes/no - ingoring broadcast for zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - "yes" or "no"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 104. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	// Does not logg ignored broadcast packets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetIgnoreLoggingBroadcast ("EXT") -> "yes"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.22. GetInterfacesInZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of known interfaces in requested zone. Special strings like 'any' or 'auto' and unknown interfaces are removed from list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - of interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 105. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetInterfacesInZone ("DMZ") -> ["eth4", "eth5"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.23. GetInterfacesInZoneSupportingAnyFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of known interfaces in requested zone. Special string 'any' in EXT zone covers all interfaces without any zone assignment.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - of interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.24. GetKnownFirewallZones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of known firewall zones (shortnames)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of firewall zones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 106. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetKnownFirewallZones() -> ["DMZ", "EXT", "INT"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.25. GetListOfForwardsIntoMasquerade

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of rules of forwarding ports to masqueraded IPs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <map <string, string> > - list of rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      list [$[ key: value ]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 107. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetListOfForwardsIntoMasquerade() -> [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "forward_to":"172.24.233.1",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "protocol":"tcp",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "req_ip":"192.168.0.3",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "req_port":"355",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "source_net":"192.168.0.0/20",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "to_port":"533"],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.26. GetListOfKnownInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of all known interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 108. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetListOfKnownInterfaces() -> ["eth1", "eth2", "modem0", "dsl5"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.27. GetLoggingSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns actual state of logging for rule taken as parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string rule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - 'ALL', 'CRIT', or 'NONE'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 109. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetLoggingSettings("ACCEPT") -> "CRIT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetLoggingSettings("DROP") -> "CRIT"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.28. GetMasquerade

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns actual state of Masquerading support.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if supported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.29. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions returns whether any firewall's configuration was modified.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if the configuration was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.30. GetProtectFromInternalZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if firewall is protected from internal zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if protected from internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.31. GetProtocolTranslatedName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns translated protocol name. Translation is provided from SuSEfirewall2 sysconfig format to l10n format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - translated string (e.g., RPC)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.32. GetServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns map of supported services in all firewall zones.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, map <string, boolean> > -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns $[service : $[ zone_name : supported_status]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 110. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // Firewall in not protected from internal zone, that's why
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // all services report that they are enabled in INT zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GetServices (["samba-server", "service:irc-server"]) -> $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "samba-server" : $["DMZ":false, "EXT":false, "INT":true],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "service:irc-server" : $["DMZ":false, "EXT":true, "INT":true]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.33. GetServicesAcceptRelated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns list of FW_SERVICES_ACCEPT_RELATED_*: Services to allow that are considered RELATED by the connection tracking engine, e.g., SLP browsing reply or Samba browsing reply.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - list of definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 111. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetServicesAcceptRelated ("EXT") -> ["0/0,udp,427", "0/0,udp,137"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetServicesAcceptRelated()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.34. GetServicesInZones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns map of supported services all network interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, map <string, boolean> > -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns $[service : $[ interface : supported_status ]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 112. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetServicesInZones (["service:irc-server"]) -> $["service:irc-server":$["eth1":true]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // No such service "something"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetServicesInZones (["something"])) -> $["something":$["eth1":nil]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GetServicesInZones (["samba-server"]) -> $["samba-server":$["eth1":false]]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.35. GetSpecialInterfacesInZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of special strings like 'any' or 'auto' and uknown interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - special strings or unknown interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 113. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetSpecialInterfacesInZone("EXT") -> ["any", "unknown-1", "wrong-3"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.36. GetStartService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function which returns if SuSEfirewall2 should start in Write process. In fact it means that SuSEfirewall2 will at the end.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if the firewall should start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.37. GetSupportRoute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if firewall supports routing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if route is supported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.38. GetTrustIPsecAs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns the trust level of IPsec packets. See SetTrustIPsecAs() for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - zone or "no"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.39. GetZoneFullName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns localized name of the zone identified by zone shortname.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - zone name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 114. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LANG=en_US GetZoneFullName ("EXT") -> "External Zone"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LANG=cs_CZ GetZoneFullName ("EXT") -> "ExternĂ­ ZĂłna"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.40. GetZoneOfInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns the firewall zone of interface, nil if no zone includes the interface. Error is reported when interface is found in multiple firewall zones, then the first appearance is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 115. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       GetZoneOfInterface ("eth-id-01:11:DA:9C:8A:2F") -> "DMZ"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.41. GetZonesOfInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of zones of requested interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - firewall zones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 116. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetZonesOfInterfaces (["eth1","eth4"]) -> ["DMZ", "EXT"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.42. GetZonesOfInterfacesWithAnyFeatureSupported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of zones of requested interfaces. Special string 'any' in 'EXT' zone is supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - firewall zones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 117. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetZonesOfInterfaces (["eth1","eth4"]) -> ["EXT"]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.43. HaveService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if requested service is allowed in respective zone. Function takes care for service's aliases (only for TCP and UDP). Service is defined by set of parameters such as port and protocol.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if service is allowed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 118. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	HaveService ("ssh", "TCP", "EXT") -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	HaveService ("ssh", "TCP", "modem0") -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	HaveService ("53", "UDP", "dsl") -> false


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.44. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for setting SuSEFirewall configuration from input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, any> import_settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.45. InterfacesSupportedByAnyFeature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns list of interfaces not mentioned in any zone and covered by the special string 'any' in zone 'EXT' if such string exists there and the zone is EXT. If the feature 'any' is not set, function returns empty list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> - of interfaces covered by special string 'any'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsAnyNetworkInterfaceSupported()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.46. IsAnyNetworkInterfaceSupported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns whether the feature 'any' network interface is supported in the firewall configuration. The string 'any' must be in the 'EXT' zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - is_supported whether the feature is supported or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.47. IsEnabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function determines if all SuSEFirewall scripts are enabled in init scripts /etc/init.d/ now. For configuration "enabled" status use GetEnableService().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if enabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.48. IsInterfaceInZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if the interface is in zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - is in zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 119. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       IsInterfaceInZone ("eth-id-01:11:DA:9C:8A:2F", "INT") -> false


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.49. IsOtherFirewallRunning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if any other firewall then SuSEfirewall2 is currently running on the system. It uses command `iptables` to get information about just active iptables rules and compares the output with current status of SuSEfirewall2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if other firewall is running

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.50. IsServiceSupportedInZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if service is supported (allowed) in zone. Service must be defined in the SuSEFirewallServices. Works transparently also with services defined by packages. Such service starts with "service:" prefix.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if supported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 120. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	// All ports defined by dns-server service in SuSEFirewallServices module
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	// are enabled in the respective zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	IsServiceSupportedInZone ("dns-server", "EXT") -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // irc-server definition exists on the system and the irc-server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // is mentioned in FW_CONFIGURATIONS_EXT variable of SuSEfirewall2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        IsServiceSupportedInZone ("service:irc-server", "EXT") -> true


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • YCP Module SuSEFirewallServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.51. IsStarted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function determines if at least one SuSEFirewall script is started now. For configuration "started" status use GetStartService().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.52. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for reading SuSEFirewall configuration. Fills internal variables only.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.53. RemoveForwardIntoMasqueradeRule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function removes rule for forwarding into masquerade from the list of current rules returned by GetListOfForwardsIntoMasquerade().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • integer remove_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetListOfForwardsIntoMasquerade()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.54. RemoveInterfaceFromZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function removes interface from defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 121. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       RemoveInterfaceFromZone ("modem0", "EXT")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.55. RemoveService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function removes service from selected zone (or for interface) for selected protocol. Function takes care about port-aliases, removes all of them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 122. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	RemoveService ("22", "TCP", "DMZ") -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        is the same as
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	RemoveService ("ssh", "TCP", "DMZ") -> true


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.56. RemoveSpecialInterfaceFromZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function removes special string from defined zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.57. ResetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Do not use this function. Only for firewall installation proposal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.58. ResetReadFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function resets flag which doesn't allow to read configuration from disk again. So you actually can reread the configuration from disk. Currently, only the first Read() call reads the configuration from disk.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.59. SaveAndRestartService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for saving configuration and restarting firewall. Is is the same as Write() but write is allways forced.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.60. SetAcceptExpertRules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets expert allow rules for zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string expert_rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.61. SetAdditionalServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets additional ports/services from taken list. Firstly, all additional services are removed also with their aliases. Secondly new ports/protocols are added. It uses GetAdditionalServices() function to get the current state and then it removes what has been removed and adds what has been added.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string protocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> new_list_services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 123. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetAdditionalServices ("TCP", "EXT", ["53", "128"])


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetAdditionalServices()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.62. SetBroadcastAllowedPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function creates allowed-broadcast-ports string from broadcast map and saves it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, list <string> > broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetBroadcastAllowedPorts() for an example of data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.63. SetEnableService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function which sets if SuSEfirewall should start in Write process

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean enable_service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.64. SetFirewallKernelModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets list of additional kernel modules to be loaded by firewall on startup.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> k_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 124. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       SuSEFirewall::SetFirewallKernelModules (["ip_conntrack_ftp","ip_nat_ftp"]);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • /etc/sysconfig/SuSEfirewall2 option nr. 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.65. SetIgnoreLoggingBroadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets yes/no - ingoring broadcast for zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string bcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 125. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	// Do not log broadcast packetes from DMZ
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetIgnoreLoggingBroadcast ("DMZ", "yes")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.66. SetInstallPackagesIfMissing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      By default SuSEfirewall2 packages are just checked whether they are installed. With this function, you can change the behavior to also offer installing the packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean new_status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.67. SetLoggingSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets state of logging for rule taken as parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string rule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 126. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetLoggingSettings ("ACCEPT", "ALL")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetLoggingSettings ("DROP", "NONE")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.68. SetMasquerade

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets Masquerade support.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean enable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.69. SetModified

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.70. SetProtectFromInternalZone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets if firewall should be protected from internal zone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean set_protect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.71. SetServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets status for several services on several network interfaces.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> services_ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean new_status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successfull

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 127. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // Disabling services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetServices (["samba-server", "service:irc-server"], ["eth1", "modem0"], false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        // Enabling services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SetServices (["samba-server", "service:irc-server"], ["eth1", "modem0"], true)


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetServicesForZones()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.72. SetServicesAcceptRelated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions sets FW_SERVICES_ACCEPT_RELATED_*: Services to allow that are considered RELATED by the connection tracking engine, e.g., SLP browsing reply or Samba browsing reply.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> ruleset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 128. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       SetServicesAcceptRelated ("EXT", ["0/0,udp,427", "0/0,udp,137"])
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServicesAcceptRelated()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.73. SetServicesForZones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets status for several services in several firewall zones.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> services_ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list<string> firewall_zones

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean new_status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successfull

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 129. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetServicesForZones (["samba-server", "service:irc-server"], ["DMZ", "EXT"], false);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetServicesForZones (["samba-server", "service:irc-server"], ["EXT", "DMZ"], true);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServicesInZones()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetServices()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.74. SetStartService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function which sets if SuSEfirewall should start in Write process.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean start_service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetStartService()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.75. SetSupportRoute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets if firewall should support routing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean set_route

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.76. SetTrustIPsecAs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function sets how firewall should trust successfully decrypted IPsec packets. It should be the zone name (shortname) or 'no' to trust packets the same as firewall trusts the zone from which IPsec packet came.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.77. StartServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions starts services needed for SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.78. StopServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions stops services needed for SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.79. SuSEFirewallIsInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether all needed packages are installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - whether SuSEfirewall2 is installed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.80. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function for writing and enabling configuration it is an union of WriteConfiguration() and ActivateConfiguration().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if succesfull

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.81. WriteConfiguration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function writes configuration into /etc/sysconfig/ and enables or disables firewall in /etc/init.d/ by the setting SetEnableService(boolean). This is a write-only configuration, firewall is never started only enabled or disabled.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.3.82. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Helper function for the backward compatibility. See WriteConfiguration(). Remove from code ASAP.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if succesful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.4.1. max_port_number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maximal number of port number, they are in the interval 1-65535 included

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.4.2. special_all_interface_string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      String which includes all interfaces not-defined in any zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.4.3. special_all_interface_zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Zone which works with the special_all_interface_string string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • NetworkInterfaces
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PortAliases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • PortRanges
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SuSEFirewallServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      282.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        283. SuSEFirewall4Network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Module for handling interfaces in SuSEfirewall2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        283.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        283.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ChangedByUser - Functions sets that a firewall proposal was changed by user by editing firewall zone of network interface (applicable during 2nd stage of installation only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • FirewallZonesComboBoxItems - Function returns list of items for combo box with all known firewall zones. There's also an item for "" (no zone or fw off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • GetZoneOfInterface - Function returns the firewall zone of interface, "" if no zone includes the interface. Error is reported when interface is found in multiple firewall zones, then the first appearance is returned. If firewall is off, "" is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • IsOn -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • IsProtectedByFirewall - Function returns if interface is protected by firewall. It means: Firewall is Running and Enabled. Interface is included in any protected firewall zone (means EXT, DMZ or INT).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProtectByFirewall - Functions sets protection of interface by the protect-status.<br> protect==true -> add interface into selected firewall zone, sets firewall to be started and enabled when booting.<br> protect==false -> removes interface from all firewall zones, if there are no other interfaces protected by firewall, stops it and removes it from boot process.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Function reads configuration of SuSEFirewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • UnconfiguredIsBlocked -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Function writes configuration of SuSEFirewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.1. ChangedByUser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions sets that a firewall proposal was changed by user by editing firewall zone of network interface (applicable during 2nd stage of installation only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.2. FirewallZonesComboBoxItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function returns list of items for combo box with all known firewall zones. There's also an item for "" (no zone or fw off).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list< list<string> > - item list for CWM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.3. GetZoneOfInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function returns the firewall zone of interface, "" if no zone includes the interface. Error is reported when interface is found in multiple firewall zones, then the first appearance is returned. If firewall is off, "" is returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.4. IsOn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - whether enabled and started

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.5. IsProtectedByFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function returns if interface is protected by firewall. It means: Firewall is Running and Enabled. Interface is included in any protected firewall zone (means EXT, DMZ or INT).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if it is protected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.6. ProtectByFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Functions sets protection of interface by the protect-status.<br> protect==true -> add interface into selected firewall zone, sets firewall to be started and enabled when booting.<br> protect==false -> removes interface from all firewall zones, if there are no other interfaces protected by firewall, stops it and removes it from boot process.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean protect_status

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.7. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function reads configuration of SuSEFirewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.8. UnconfiguredIsBlocked

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - Whether the UI should warn about interfaces that are not in any zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.3.9. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function writes configuration of SuSEFirewall.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SuSEFirewallProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          283.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            284. SuSEFirewallExpertRules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface manipulation of /etc/sysconfig/SuSEFirewall (expert rules)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            284.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            284.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AddNewAcceptRule - Adds a new accept-rule. Possible keys for parameters are "network", "protocol", "dport" and "sport". Needed are "network" and "protocol".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DeleteRuleID - Deletes Custom Rule defined by the ID of the rule. The ID is an order of list returned by GetListOfAcceptRules(). ID starts at number 0. Every time you delete some rule, the list is, of course, regenerated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetAllExpertRulesProtocols - Returns list of all protocols accepted by the expert rules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetListOfAcceptRules - Returns list of rules (maps) describing protocols and ports that are allowed to be accessed from listed hosts. "network" and "protocol" are needed arguments, "dport" and "sport" are optional. Undefined values are returned as empty strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IsValidNetwork - Function checks the network definition used for firewall expert rules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoveAcceptRule - Removes a single expert firewall rule.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ValidNetwork - Returns string of valid network definition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.1. AddNewAcceptRule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Adds a new accept-rule. Possible keys for parameters are "network", "protocol", "dport" and "sport". Needed are "network" and "protocol".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map <string, string> params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 130. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               AddNewAcceptRule (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "EXT",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   $["network":"192.168.0.1/255.255.240.0", "protocol":"tcp", "sport":"22"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ) -> true


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetListOfAcceptRules()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • RemoveAcceptRule()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.2. DeleteRuleID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deletes Custom Rule defined by the ID of the rule. The ID is an order of list returned by GetListOfAcceptRules(). ID starts at number 0. Every time you delete some rule, the list is, of course, regenerated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer rule_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 131. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               	DeleteRuleID (0) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetListOfAcceptRules()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.3. GetAllExpertRulesProtocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns list of all protocols accepted by the expert rules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> - of protocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <string> allowed_expert_protocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.4. GetListOfAcceptRules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns list of rules (maps) describing protocols and ports that are allowed to be accessed from listed hosts. "network" and "protocol" are needed arguments, "dport" and "sport" are optional. Undefined values are returned as empty strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • list <map <string, string> > - of rules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This might return, e.g., [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   // All requests from 80.44.11.22 to TCP port 22
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              	   $[ "network" : "80.44.11.22",   "protocol" : "tcp", "dport" : "22",  "sport" : ""   ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   // All requests from network 80.44.11.0/24 to UDP port 53 originating on port 53
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              	   $[ "network" : "80.44.11.0/24", "protocol" : "udp", "dport" : "53",  "sport" : "53" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   // All requests from network 0/0 (everywhere) to TCP port 443
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              	   $[ "network" : "0/0",           "protocol" : "tcp", "dport" : "443", "sport" : ""   ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 132. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               GetListOfAcceptRules("EXT") -> $[]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IsValidNetwork()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.5. IsValidNetwork

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function checks the network definition used for firewall expert rules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string network

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - if it is a valid network definition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 133. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.1")               -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.355")             -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.0/24")            -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.1/32")            -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.1/0")             -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.0/255.255.0.0")   -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.0/255.255.333.0") -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("192.168.0.0/255.255.224.0") -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               IsValidNetwork("0/0")                       -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • `man iptables`

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.6. RemoveAcceptRule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Removes a single expert firewall rule.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • map <string, string> params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 134. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               RemoveAcceptRule (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "EXT",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   $["network":"192.168.0.1/255.255.240.0", "protocol":"tcp", "sport":"22"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ) -> true


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetListOfAcceptRules() for possible keys in map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • AddNewAcceptRule()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.3.7. ValidNetwork

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns string of valid network definition.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string - describing the valid network.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Netmask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SuSEFirewall

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              284.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                285. SuSEFirewallProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Functional interface for SuSEFirewall installation proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                285.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                285.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetChangedByUser - Local function returns if proposal was changed by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetProposalInitialized - Local function returns if proposal was initialized already

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OpenServiceOnNonDialUpInterfaces - Function opens up the service on all non-dial-up network interfaces. If there are no network interfaces known and the 'any' feature is supported, function opens the service for the zone supporting that feature. If there are only dial-up interfaces, function opens the service for them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ProposalSummary - Function returns the proposal summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Propose - Function proposes the SuSEfirewall2 configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Reset - Function fills up default configuration into internal values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetChangedByUser - Function sets that proposal was changed by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetProposalInitialized - Function sets that proposal was initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.1. GetChangedByUser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Local function returns if proposal was changed by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - if proposal was changed by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.2. GetProposalInitialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Local function returns if proposal was initialized already

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - if proposal was initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.3. OpenServiceOnNonDialUpInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function opens up the service on all non-dial-up network interfaces. If there are no network interfaces known and the 'any' feature is supported, function opens the service for the zone supporting that feature. If there are only dial-up interfaces, function opens the service for them.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list <string> fallback_ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.4. ProposalSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function returns the proposal summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, string> - proposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  map $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  	"output" : "HTML Proposal Summary",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  	"warning" : "HTML Warning Summary",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.5. Propose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function proposes the SuSEfirewall2 configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.6. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function fills up default configuration into internal values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.7. SetChangedByUser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function sets that proposal was changed by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.3.8. SetProposalInitialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function sets that proposal was initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean initialized

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Linuxrc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • SuSEFirewallServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  285.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    286. SuSEFirewallServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Definition of Supported Firewall Services and Port Aliases.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    286.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    286.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.1. GetFilenameFromServiceDefinedByPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Creates a file name from service name defined by package. Service MUST be defined by package, otherwise it returns 'nil'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string - file name (e.g., 'abc')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 135. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetFilenameFromServiceDefinedByPackage ("service:abc") -> "abc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetFilenameFromServiceDefinedByPackage ("abc") -> nil


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.2. GetListOfServicesAddedByPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns list of service-ids defined by packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - service ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.3. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether configuration was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.4. GetNeededBroadcastPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed ports allowing broadcast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of needed broadcast ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.5. GetNeededIPProtocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed IP protocols for service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of needed IP protocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.6. GetNeededPortsAndProtocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed ports and protocols for service. Function cares about if the service is defined or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, list <string> > - of needed ports and protocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 136. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	GetNeededPortsAndProtocols ("service:aaa") -> $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"tcp_ports"       : [ "122", "ftp-data" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"udp_ports"       : [ "427" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"rpc_ports"       : [ "portmap", "ypbind" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"ip_protocols"    : [],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"broadcast_ports" : [ "427" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	];


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.7. GetNeededRPCPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed RPC ports for service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of needed RPC ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.8. GetNeededTCPPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed TCP ports for service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of needed TCP ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.9. GetNeededUDPPorts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns needed UDP ports for service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of needed UDP ports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.10. GetPossiblyConflictServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns list of possibly conflicting services. Conflicting services are for instance nis-client and nis-server. DEPRECATED - we currently don't have such services - services are defined by packages.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list <string> - of conflicting services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.11. GetSupportedServices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns the map of supported (known) services.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, string> - supported services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	$[ service_id : localized_service_name ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	$[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	  "dns-server" : "DNS Server",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "vnc" : "Remote Administration",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.12. IsKnownService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function returns if the service_id is a known (defined) service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if is known (defined)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.13. ReadServicesDefinedByRPMPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Reads definition of services that can be used in FW_CONFIGURATIONS_[EXT|INT|DMZ] in SuSEfirewall2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.14. ResetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets that configuration was not modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.15. ServiceDefinedByPackage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns whether the service ID is defined by package. Returns 'false' if it isn't.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - whether service is defined by package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 137. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	ServiceDefinedByPackage ("http-server") -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	ServiceDefinedByPackage ("service:http-server") -> true


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.16. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sets that configuration was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.3.17. SetNeededPortsAndProtocols

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Immediately writes the configuration of service defined by package to the service definition file. Service must be defined by package, this function doesn't work for hard-coded services (SuSEFirewallServices).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • string service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map <string, list <string> > store_definition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - if successful (nil in case of developer's mistake)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example 138. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	SetNeededPortsAndProtocols (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		"service:something",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		$[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      			"tcp_ports"       : [ "22", "ftp-data", "400:420" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      			"udp_ports"       : [ ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      			"rpc_ports"       : [ "portmap", "ypbind" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      			"ip_protocols"    : [ "esp" ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      			"broadcast_ports" : [ ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      		]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      	);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsKnownService()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ServiceDefinedByPackage()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • FileUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      286.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        287. SuSERelease

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        287.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Jiri Srain <jsrain@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Purpose: Responsible for getting information from the /etc/SuSE-release

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (and similar for other system) file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        287.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReleaseInformation - Get information about the release for displaying in the selection list of found systems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReleaseName - Get information about the release for using in the help text Is limited for the currently running product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ReleaseVersion - Get information about the release Is limited for the currently running product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.3.1. ReleaseInformation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get information about the release for displaying in the selection list of found systems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - the release information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.3.2. ReleaseName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get information about the release for using in the help text Is limited for the currently running product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - the release information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.3.3. ReleaseVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get information about the release Is limited for the currently running product

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - the release information

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Stage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          287.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            288. Sudo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            288.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              288.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetModified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • PollAbort - Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call. :*

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read - Read all sudo settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Write - Write all sudo settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.3.1. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.3.2. PollAbort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checks whether an Abort button has been pressed. If so, calls function to confirm the abort call. :*

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true if abort confirmed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.3.3. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all sudo settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.3.4. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write all sudo settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SCR
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • UsersCache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                288.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  289. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Support for summaries of the configured devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  289.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  289.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddHeader - Add a RichText section header to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddLine - Add a line to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddListItem - Add a list item to an existing summary. Requires a previous call to 'summaryOpenList()'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddNewLine - Add a newline to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • AddSimpleSection - Add a simple section to an existing summary, consisting of a header and one single item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • CloseList - End a list within a summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Device - Function that creates description of one device.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • DevicesList - Function that creates the whole final product. "Not detected" will be returned if the list is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • NotConfigured - Function that creates a 'Not configured.' message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OpenList - Start a list within a summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.1. AddHeader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add a RichText section header to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary including the new header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.2. AddLine

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add a line to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary including the new line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.3. AddListItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add a list item to an existing summary. Requires a previous call to 'summaryOpenList()'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary including the new line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.4. AddNewLine

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add a newline to an existing summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.5. AddSimpleSection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add a simple section to an existing summary, consisting of a header and one single item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary including the new line

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.6. CloseList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    End a list within a summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.7. Device

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function that creates description of one device.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - String with the item.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.8. DevicesList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function that creates the whole final product. "Not detected" will be returned if the list is empty.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> devices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - The resulting text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.9. NotConfigured

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function that creates a 'Not configured.' message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - String with the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.3.10. OpenList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Start a list within a summary.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - the new summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    289.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      290. Support

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      290.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Export - Dump the support settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Import - Get all support settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Read - Read all support settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SetModified - Mark as modified, for Autoyast.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SetWriteOnly - Set write_only flag (for autoinstalation).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write - Write all support settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • WriteOnly -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • root_pw - root password for running supportconfig if module run as non-root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Dump the support settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all support settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.8. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read all support settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.9. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Mark as modified, for Autoyast.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.10. SetWriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set write_only flag (for autoinstalation).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.11. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.12. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Write all support settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.3.13. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if module is marked as "write only" (don't start services etc...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.4.1. root_pw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        root password for running supportconfig if module run as non-root

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Map
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • PackageSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        290.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          291. Sysconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Data for configuration of sysconfig, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          291.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Ladislav Slezak <lslezak@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          291.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - Dump the sysconfig settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import - Set all sysconfig settings from the list and read information from files (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read - Read all sysconfig variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • RegisterAgents - Register .syseditor path (use INI agent in multiple file mode)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Search - Search in syscnfig files for value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set - Set all sysconfig settings from the list (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary - Create a textual summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Write all sysconfig settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_all - Get list of all variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_all_names - Get map of all variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_description - Get description of selected variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_file_from_id - Get file name where is variable located from variable identification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_location_from_id - Get variable location in tree widget from variable identification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_metadata - Get metadata lines from input string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_modified - Get list of modified variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_name_from_id - Get variable name from variable identification or empty string if input is invalid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • get_only_comment - Get comment without metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • modified - Return modification status of variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • parse_metadata - Parse metadata from comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • remove_whitespaces - Remove white spaces at beginning or at the end of string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • set_value - Set new variable value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Dump the sysconfig settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.2. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set all sysconfig settings from the list and read information from files (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.3. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.4. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read all sysconfig variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.5. RegisterAgents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Register .syseditor path (use INI agent in multiple file mode)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.6. Search

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search in syscnfig files for value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean show_progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - List of found variables (IDs)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.7. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set all sysconfig settings from the list (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map> settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.8. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a textual summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.9. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Write all sysconfig settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.10. get_all

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get list of all variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - List of variable identifications

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.11. get_all_names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get map of all variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, list<string> > - Map of variable names, key is variable name, value is a list of variable identifications

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.12. get_description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get description of selected variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string varid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, any> - Description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.13. get_file_from_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get file name where is variable located from variable identification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.14. get_location_from_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get variable location in tree widget from variable identification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Variable location

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.15. get_metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get metadata lines from input string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - Metadata lines in list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.16. get_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get list of modified variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - List of modified variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.17. get_name_from_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get variable name from variable identification or empty string if input is invalid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Variable name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 139. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             get_name_from_id("var$file") -> "var"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.18. get_only_comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get comment without metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - Comment used as variable description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.19. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return modification status of variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string varid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - True if variable was modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.20. parse_metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parse metadata from comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string comment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map<string, string> - parsed metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.21. remove_whitespaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove white spaces at beginning or at the end of string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - String without white spaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.3.22. set_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set new variable value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string new_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force_change

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol - Result: `not_found (specified variable was not found in config file), `not_valid (new value is not valid - doesn't match variable type definition), `ok (success)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            291.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              292. SystemFilesCopy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Functionality for copying files from another systems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              292.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              292.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CopyFilesToSystem - Proceeds the copying of all files in inst-sys (that were copied from another partition before) to the directory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CopyFilesToTemp - Mounts the partition and proceeds the copying files from that partition to the inst-sys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • CreateDirectoryIfMissing - Checks whether the directory exists and creates it if it is missing If the path exists but it is not a directory, it tries to create another directory and returns its name. 'nil' is returned when everythig fails.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetCopySystemFiles - Returns list of copy_files definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • GetUseControlFileDef - Sets whether copy_files from control file should be used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SaveInstSysContent - Function reads <globals><save_instsys_content /></globals> from control file and copies all content from inst-sys to the just installed system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetCopySystemFiles - Sets new rules which files will be copied during installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • SetUseControlFileDef - Sets whether to use copy_files from control file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.1. CopyFilesToSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Proceeds the copying of all files in inst-sys (that were copied from another partition before) to the directory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string extract_to_dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.2. CopyFilesToTemp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Mounts the partition and proceeds the copying files from that partition to the inst-sys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <string> filenames

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string copy_to

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                copy_to   == "/root/" (where to copy it to the installed system)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.3. CreateDirectoryIfMissing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Checks whether the directory exists and creates it if it is missing If the path exists but it is not a directory, it tries to create another directory and returns its name. 'nil' is returned when everythig fails.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string create_directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.4. GetCopySystemFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns list of copy_files definitions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetCopySystemFiles for more info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.5. GetUseControlFileDef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets whether copy_files from control file should be used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - whether to use them

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SetUseControlFileDef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.6. SaveInstSysContent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function reads <globals><save_instsys_content /></globals> from control file and copies all content from inst-sys to the just installed system.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <globals>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     <save_instsys_content config:type="list">
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         <save_instsys_item>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             <instsys_directory>/root/</instsys_directory>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             <system_directory>/root/inst-sys/</system_directory>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         </save_instsys_item>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     </save_instsys_content>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 </globals>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.7. SetCopySystemFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets new rules which files will be copied during installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <map> new_copy_files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "copy_to_dir" : (string) "system_directory_to_copy_to",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "mandatory_files" : (list <string>) [ list of mandatory files ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "optional_files" : (list <string>) [ list of optional files ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example 140. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SetCopySystemFiles ([
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $["copy_to_dir":"/root/backup", "mandatory_files":["/etc/passwd", "/etc/shadow"]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $["copy_to_dir":"/root/backup", "mandatory_files":["/etc/ssh/ssh_host_dsa_key"], "optional_files":["/etc/ssh/ssh_host_rsa_key.pub"]]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ])


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FATE #305019: configure the files to copy from a previous installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.3.8. SetUseControlFileDef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets whether to use copy_files from control file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean new_value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetUseControlFileDef

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InstData
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                292.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  293. SystemProfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  293.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the system-profile settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all system-profile settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Read - Read all system-profile settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SetModified - Mark as modified, for Autoyast.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Write - Write all system-profile settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • executeSmoltCmd - Execute the smolt command to read or submit data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • moduleTitle - Module title to use - will be selected and set in the client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dump the system-profile settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.3. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get all system-profile settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.4. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.5. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Read all system-profile settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.6. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mark as modified, for Autoyast.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.7. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write all system-profile settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.3.8. executeSmoltCmd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Execute the smolt command to read or submit data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • symbol mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.4.1. moduleTitle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Module title to use - will be selected and set in the client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    293.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      294. SystemSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      294.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      294.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          294.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          294.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          294.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          294.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Bootloader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Bootloader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Bootloader
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          294.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            295. TFTP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Handle TFTP Requests

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            295.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            295.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Get - Send a get request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Put - Send a put request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              295.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              295.3.1. Get

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Send a get request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string local

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              295.3.2. Put

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Send a put request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string remote

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string local

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              295.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              295.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              296. TabPanel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              296.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • The DumbTab widget must have id `tab. The ids of the items of the DumbTab

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • widget must be made of symbols.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              296.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Init - When calling this function the DumbTab widget must already exist.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                296.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                296.3.1. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                When calling this function the DumbTab widget must already exist.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map<symbol, map> d

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol fallback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                296.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                296.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                297. TablePopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Routines for Table/Popup interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                297.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                297.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CreateTableDescr - Get the map with the table widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DisableTable - Disable whole table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • EnableTable - Enable whole table (except buttons that should be grayed according to currently selected table row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TableHandle - Handle the event that happened on the table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TableHandleWrapper - Wrapper for TableHandle using CWM::GetProcessedWidget () for getting widget description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TableInit - Initialize the displayed table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TableInitWrapper - Wrapper for TableInit using CWM::GetProcessedWidget () for getting widget description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • askForNewOption - Displaye popup for option to edit choosing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • deleteTableItem - Delete an item from the table Just a wrapper for module-specific function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • id2key - Get option key from the option id global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • key2descr - Get option description map from the key global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • singleOptionEditPopup - Display and handle the popup for option

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • tableEntryChanged - Realize if table entry was changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • updateButtons - Enable or disable the Delete and up/down buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • updateOptionMap - Update the option description map in order to contain handlers of all needed functions global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.1. CreateTableDescr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the map with the table widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> attrib

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> widget_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> - table widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.2. DisableTable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable whole table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.3. EnableTable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable whole table (except buttons that should be grayed according to currently selected table row

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.4. TableHandle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Handle the event that happened on the table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map event_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol - modified event if needed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.5. TableHandleWrapper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Wrapper for TableHandle using CWM::GetProcessedWidget () for getting widget description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map event_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol - return value for wizard sequencer or nil

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.6. TableInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Initialize the displayed table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.7. TableInitWrapper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Wrapper for TableInit using CWM::GetProcessedWidget () for getting widget description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.8. askForNewOption

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Displaye popup for option to edit choosing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list possible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean editable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - option identifies, nil if canceled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.9. deleteTableItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete an item from the table Just a wrapper for module-specific function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any opt_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if was really deleted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.10. id2key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get option key from the option id global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any opt_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - option key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.11. key2descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get option description map from the key global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string opt_key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> - option description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.12. singleOptionEditPopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Display and handle the popup for option

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> option

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • symbol - `_tp_ok or `_tp_cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.13. tableEntryChanged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Realize if table entry was changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any opt_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> opt_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if was changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.14. updateButtons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable or disable the Delete and up/down buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string,any> opt_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.3.15. updateOptionMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update the option description map in order to contain handlers of all needed functions global only because of testsuites

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> opt_descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map fallbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map<string, any> - updated option description map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • CWM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Report

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  297.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    298. Taotie

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    298.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export - Dump the taotie settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import - Get all taotie settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Overview - Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - return true if abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.2. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.3. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Dump the taotie settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.4. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get all taotie settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.5. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.6. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.7. Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create an overview table with all configured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list - table items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.3.8. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • list - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      298.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        299. Testsuite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Main testsuite module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        299.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        299.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Dump - Dump value to the testsuite output (keyword: Dump)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • DumpFile - Dump file contents to the testsuite output (keyword: File)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Init -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Test -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.3.1. Dump

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Dump value to the testsuite output (keyword: Dump)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.3.2. DumpFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Dump file contents to the testsuite output (keyword: File)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.3.3. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<any> INPUT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any DEFAULT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list - of various SCR return values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.3.4. Test

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any FUNCTION

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • list<any> INPUT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any DEFAULT

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • any - whatever the FUNCTION returns

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          299.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300. TftpServer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Data for configuration of TftpServer, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • AutoPackages - Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export - Dump the tftp-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ForeignServersError - Return error string to be used in WriteOnly (for autoinst) or before the edit dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GetModified - Returns true if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Import - Get all tftp-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ParseServerArgs - Extract the directory and other arguments. global to make testing easier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read - Read all tftp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set - Set module data, without validity checking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SetModified - Function sets an internal variable indicating that any settings were modified to "true". Used for autoinst cloning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Write - Write all tftp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • WriteOnly - Write all tftp-server settings without actually (re)starting the service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • directory - Image directory, last argument of in.tftpd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • foreign_servers - Detect who is serving tftp: Inetd may be running, it is the default. But it is ok unless it is serving tftp. So we detect who is serving tftp and warn if it is not xinetd or in.tftpd. If nonempty, the user is notified and the module gives up.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • other_args - Other arguments to in.tftpd, ie. not including -s or /dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • required_packages - Required packages for operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • start - Start tftpd via xinetd?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.1. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return needed packages and packages to be removed during autoinstallation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - of lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.2. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Dump the tftp-server settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.3. ForeignServersError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return error string to be used in WriteOnly (for autoinst) or before the edit dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - error string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.4. GetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns true if the settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - settings were modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.5. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get all tftp-server settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.6. ParseServerArgs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Extract the directory and other arguments. global to make testing easier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string server_args

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.7. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Read all tftp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.8. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Set module data, without validity checking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.9. SetModified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function sets an internal variable indicating that any settings were modified to "true". Used for autoinst cloning.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.10. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • string - Html formatted configuration summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.11. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Write all tftp-server settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.3.12. WriteOnly

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Write all tftp-server settings without actually (re)starting the service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4.1. directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Image directory, last argument of in.tftpd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4.2. foreign_servers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Detect who is serving tftp: Inetd may be running, it is the default. But it is ok unless it is serving tftp. So we detect who is serving tftp and warn if it is not xinetd or in.tftpd. If nonempty, the user is notified and the module gives up.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4.3. other_args

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Other arguments to in.tftpd, ie. not including -s or /dir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4.4. required_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required packages for operation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.4.5. start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Start tftpd via xinetd?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          300.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301. Timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Timezone related stuff

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Thomas Roelz <tom@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Export - AutoYaST interface function: Return the Timezone configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetCountryForTimezone - Return the country part of language code for given timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetDateTime - GetDateTime()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetDateTimeMap - Return current date and time in the map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetLanguageForTimezone - Return the language code for given timezone (by reverse searching the "language -> timezone" map)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetTimezoneCountry - Return translated country name of given timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetTimezoneForLanguage - GetTimezoneForLanguage()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Import - AutoYaST interface function: Get the Timezone configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • MakeProposal - Return proposal list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Modified - was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PopVal - restore the original data from internal map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProposeLocaltime - Return true if localtime should be proposed as default Based on current hardware configuration: Win partitions present or 32bit Mac

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PushVal - save the initial data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Read - Read timezone settings from sysconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Region - Return list of regions for timezone selection list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ResetZonemap - Clear the internal map with timezones, so the timezone data could be retranslated next time when they are needed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Save - Save()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Selection - Selection()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Set - Set()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetTime - Set the new time and date given by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetTimezoneForLanguage - Set the timezone for the given system language.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Summary - AutoYaST interface function: Return the summary of Timezone configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SystemTime2HWClock - Set the Hardware Clock to the current System Time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Timezone - Timezone()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • UpdateTimezone - Convert the duplicated timezone to the only one supported Temporary solution - a result of discussion of bug #47472

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • get_zonemap - get_zonemap()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • modified - if anyuthing was modified (currently for auto client only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • windows_partition - If there is windows partition, assume that local time is used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.1. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AutoYaST interface function: Return the Timezone configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map - with the settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.2. GetCountryForTimezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return the country part of language code for given timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.3. GetDateTime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GetDateTime()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean real_time

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean locale_format

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - The string output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.4. GetDateTimeMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return current date and time in the map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.5. GetLanguageForTimezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return the language code for given timezone (by reverse searching the "language -> timezone" map)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.6. GetTimezoneCountry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return translated country name of given timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.7. GetTimezoneForLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GetTimezoneForLanguage()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string sys_language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string default_timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - The timezone for this language, e.g. "US/Eastern" or the default value if nothing found.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.8. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AutoYaST interface function: Get the Timezone configuration from a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.9. MakeProposal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return proposal list of strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force_reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean language_changed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<string> - user readable description. If force_reset is true reset the module to the timezone stored in default_timezone.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.10. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            was anything modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.11. PopVal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            restore the original data from internal map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.12. ProposeLocaltime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return true if localtime should be proposed as default Based on current hardware configuration: Win partitions present or 32bit Mac

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.13. PushVal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            save the initial data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.14. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Read timezone settings from sysconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.15. Region

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return list of regions for timezone selection list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.16. ResetZonemap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Clear the internal map with timezones, so the timezone data could be retranslated next time when they are needed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.17. Save

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Save()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.18. Selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Selection()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer num

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list - map for timezones 'timezone_id' is used internally in Set and Probe functions. 'timezone_name' is a user-readable string. Uses Language::language for translation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Set()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.19. Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string zone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean really

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer - the number of the region that contains the timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.20. SetTime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the new time and date given by user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string year

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string month

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string day

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string hour

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string minute

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string second

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.21. SetTimezoneForLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the timezone for the given system language.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string sys_language

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void - the number of the region that contains the timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.22. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AutoYaST interface function: Return the summary of Timezone configuration as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string - summary string (html)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.23. SystemTime2HWClock

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the Hardware Clock to the current System Time.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.24. Timezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Timezone()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Set()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.25. UpdateTimezone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Convert the duplicated timezone to the only one supported Temporary solution - a result of discussion of bug #47472

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string tmz

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.3.26. get_zonemap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            get_zonemap()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list<map<string,any> > - timezone DB (map)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • get_lang2tz()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            if anyuthing was modified (currently for auto client only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.4.2. windows_partition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If there is windows partition, assume that local time is used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HTML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Language
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Misc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            301.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              302. TreePanel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Expert Partitioner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              302.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Arvin Schnell <aschnell@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • The Tree widget must have id `tree. The ids of the items of the Tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • widget must be made of symbols or strings.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              302.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Destroy - Delegating destroying to the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Handle - Handle user input by either switching the panel or delegating the input to the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Init - Initialises internal data and calls the create function of the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Update - Update the contents of the Tree widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.3.1. Destroy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delegating destroying to the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.3.2. Handle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Handle user input by either switching the panel or delegating the input to the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • symbol widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.3.3. Init

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Initialises internal data and calls the create function of the selected panel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map<any, map> d

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.3.4. Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update the contents of the Tree widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map<any, map> d

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<term> tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • any new_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                302.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303. Tv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data for configuration of tv, input and output functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardAddCurrent - Add the <B>current_card</B> to the <B>cards</B>. Try to fill holes after removes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardGet - Get <B>index</B>th card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardIndexUniqKey - Return card index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardRemove - Remove <B>index</B>th card. Does not touch <B>current_card</B>. (In fact, we just replace the card on the position of 'index' with nil.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardReplaceWithCurrent - Replace <B>index</B>th card with the <B>current_card</B>.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardsAsItemMap - Creates the content of the "configured card" Table in OverviewDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardsAsItems - Creates the content of the "configured card" Table in OverviewDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardsDBVendorGetCards - Create a list of cards of the selected vendor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardsDBVendorsAsItems - Create a list of items for the "Vendors:" SelectionBox in the ManualDialog() screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • CardsUniqueKeys - Creates a list of unique keys of cards that are already installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Detect - Scan for the TV cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DetectedCardGet - Get <B>index</B>th card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DetectedCardsAsItems - List of the TV cards acceptable by the Selection Box widget in the DetectedDialog(). The already installed cards are filtered out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Export - Dump the tv settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetIRCModule - Decides which LIRC module can be used accoring to current TV card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetKernelModuleInfo - Return description of one kernel module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetTuner - Returns the tuner map according to its ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • GetTvCard - Grab the TV card from the database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Import - Get all TV settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InitializeStationsConfig - Initialize stations configuration (read global config etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • InstalledCardsSummary - Returns a list with the overview of the installed cards. It can be used in Summary::DevicesList().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • IsDirty - If the configuration was changed by the user, this will return true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • LoadIRCModulesDescription - Load the desription of irc kernel modules (modinfo)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ModuleParametersAsItems - List of the parameters for the selected kernel module acceptable by the Table widget in the ManualDetailsDialog().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ModulesAsItems - List of the kernel modules for radio cards acceptable by the Combo Box widget in the ManualDetailsDialog().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Propose - Create a configuration automagically.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Read - Read all TV card settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadCardsDatabase - Read the database of the TV cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadIRC - Read IRC settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadKernelModules - Get a list of the available v4l kernel modules and store it to <B>kernel_modules</B> map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadSettings - Fill the map of all tv settings from the SCR.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadStationsConfig - Read the whole contents of xawtvrc file and return it as a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadTunersDatabase - Read the database of the tuners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadUserSettings - Read the state of "not_ask" variable (if the TV/radio application presence should be checked again next time)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary - Build a textual summary that can be used e.g. in inst_hw_config () or something similar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TunersDBAsItems - List of tuners for TV cards acceptable by the SelectionBox widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TunersDBHasTunersFor - Are there any tuners for the <B>kernel_module</B>?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TunersDBSelectTuner - Return the <B>number</B>th tuner.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Write - Update the SCR according to tv settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • WriteIRC - Write IRC settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • WriteStationsConfig - Write to /etc/X11/xawtvrc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • tv_tmp_start - Load the modules for TV suport now, use current (not yet saved) options It calls something like 'modprobe -C /dev/null bttv card=2 tuner=23'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • cards_database - Database of the TV cards for the manual configuration. It is a list of maps with vendors, and each of the vendor contains a list of cards with the kernel module and its parameters. It is read in ReadDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • channels_config - Configuration of TV stations (contents of /etc/X11/xawtvrc file)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • current_card - The card which is currently being configured. It will become an entry in the "cards" list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • current_card_no - The number of card which is currently being configured. It has its meaning only when editing the entry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • irc_config - configuration file for IR control

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • irc_modified - Is IRC modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • irc_module - kerenel module used for lirc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • irc_modules - Map of lirc modules, together with their description (from modinfo)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • irc_modules_list - Kernel modules for LIRC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • kernel_modules - Map of available TV kernel modules and their parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • not_ask - If YaST should check the presence of TV/radio application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • proposal_valid - Becomes true, when the module is initialized for proposal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • remotes - Paths to config files of various remote controls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • stations_modified - Were TV stations modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • use_irc - Is IRC used?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • used_modprobe_conf - This is true, if tv data were read from /etc/modprobe.conf On write, they shoud be removed and written only to /etc/modprobe.d/tv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.1. CardAddCurrent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Add the <B>current_card</B> to the <B>cards</B>. Try to fill holes after removes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer - Index of the added card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.2. CardGet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get <B>index</B>th card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • any - The 'index'th card or nil

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.3. CardIndexUniqKey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return card index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string uniq

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer - index or nil if ID was not found

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.4. CardRemove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Remove <B>index</B>th card. Does not touch <B>current_card</B>. (In fact, we just replace the card on the position of 'index' with nil.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Returns true if the card was erased.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.5. CardReplaceWithCurrent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Replace <B>index</B>th card with the <B>current_card</B>.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Returns true if successfully replaced.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.6. CardsAsItemMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Creates the content of the "configured card" Table in OverviewDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list<map<string,any> > - List of `item()s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.7. CardsAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Creates the content of the "configured card" Table in OverviewDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of `item()s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.8. CardsDBVendorGetCards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of cards of the selected vendor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map autodetected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer sel_vendor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of cards of the selected vendor.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.9. CardsDBVendorsAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a list of items for the "Vendors:" SelectionBox in the ManualDialog() screen.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map autodetected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string mod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of list of `item()s and number of the vendor to preselect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.10. CardsUniqueKeys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Creates a list of unique keys of cards that are already installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of the unque keys.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.11. Detect

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scan for the TV cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Return false if the module should be terminated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.12. DetectedCardGet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get <B>index</B>th card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - The 'index'th card or nil

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.13. DetectedCardsAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of the TV cards acceptable by the Selection Box widget in the DetectedDialog(). The already installed cards are filtered out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of TV cards including Other (not detected) with `id(-1))

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.14. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Dump the tv settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.15. GetIRCModule

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Decides which LIRC module can be used accoring to current TV card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - module name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.16. GetKernelModuleInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return description of one kernel module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.17. GetTuner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns the tuner map according to its ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string kernel_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string tuner_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Tuner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.18. GetTvCard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Grab the TV card from the database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string card_model

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string modname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - card map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.19. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get all TV settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.20. InitializeStationsConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Initialize stations configuration (read global config etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.21. InstalledCardsSummary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns a list with the overview of the installed cards. It can be used in Summary::DevicesList().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - Description of the installed cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.22. IsDirty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If the configuration was changed by the user, this will return true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Has the configuration changed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.23. LoadIRCModulesDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Load the desription of irc kernel modules (modinfo)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.24. ModuleParametersAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of the parameters for the selected kernel module acceptable by the Table widget in the ManualDetailsDialog().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string selected_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of `item()s.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.25. ModulesAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of the kernel modules for radio cards acceptable by the Combo Box widget in the ManualDetailsDialog().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string selected_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of `item()s

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.26. Propose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a configuration automagically.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.27. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all TV card settings from the SCR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.28. ReadCardsDatabase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read the database of the TV cards.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Was the read successful?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.29. ReadIRC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read IRC settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • any - Symbol for next or abort dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.30. ReadKernelModules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get a list of the available v4l kernel modules and store it to <B>kernel_modules</B> map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Returns <B>true</B>.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.31. ReadSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fill the map of all tv settings from the SCR.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Was the reading succesfull?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.32. ReadStationsConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read the whole contents of xawtvrc file and return it as a map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path pth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.33. ReadTunersDatabase

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read the database of the tuners.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Was the read successful?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.34. ReadUserSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read the state of "not_ask" variable (if the TV/radio application presence should be checked again next time)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - not_ask value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.35. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Build a textual summary that can be used e.g. in inst_hw_config () or something similar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - Summary of the configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.36. TunersDBAsItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of tuners for TV cards acceptable by the SelectionBox widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string kernel_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map selected_tuner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list - List of `item()s.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.37. TunersDBHasTunersFor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Are there any tuners for the <B>kernel_module</B>?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string kernel_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - Are there available tuners for it?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.38. TunersDBSelectTuner

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return the <B>number</B>th tuner.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string kernel_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • integer number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map - Tuner.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.39. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update the SCR according to tv settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • block<boolean> abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.40. WriteIRC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write IRC settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • any - Symbol for next or abort dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.41. WriteStationsConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write to /etc/X11/xawtvrc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.3.42. tv_tmp_start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Load the modules for TV suport now, use current (not yet saved) options It calls something like 'modprobe -C /dev/null bttv card=2 tuner=23'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - empty string on success, error message otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.1. cards_database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Database of the TV cards for the manual configuration. It is a list of maps with vendors, and each of the vendor contains a list of cards with the kernel module and its parameters. It is read in ReadDialog()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.2. channels_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Configuration of TV stations (contents of /etc/X11/xawtvrc file)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.3. current_card

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The card which is currently being configured. It will become an entry in the "cards" list.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.4. current_card_no

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of card which is currently being configured. It has its meaning only when editing the entry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.5. irc_config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                configuration file for IR control

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.6. irc_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is IRC modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.7. irc_module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                kerenel module used for lirc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.8. irc_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Map of lirc modules, together with their description (from modinfo)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.9. irc_modules_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Kernel modules for LIRC

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.10. kernel_modules

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Map of available TV kernel modules and their parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.11. not_ask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If YaST should check the presence of TV/radio application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.12. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Becomes true, when the module is initialized for proposal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.13. remotes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Paths to config files of various remote controls

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.14. stations_modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Were TV stations modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.15. use_irc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Is IRC used?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.4.16. used_modprobe_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This is true, if tv data were read from /etc/modprobe.conf On write, they shoud be removed and written only to /etc/modprobe.d/tv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Confirm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HWConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ModulesComments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Sound
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Summary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • WizardHW

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                303.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • sound/write_routines.ycp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • tv/misc.ycp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                304. TypeRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type repository for validation of user-defined types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                304.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Stanislav Visnovsky <visnov@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                304.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.3.1. TypeRepository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructor, defines the known types.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.3.2. enum_validator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generic enumerated type validator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.3.3. is_a

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Validate, that the given value is of given type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true, if the value can be considered to be of a given type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.3.4. regex_validator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generic regular expression validator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string regex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean - true if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Netmask
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  304.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305. URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Manipulate and Parse URLs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Anas Nashif <nashif@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Build - Build URL from tokens as parsed with Parse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Check - Check URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EscapeString - Escape reserved characters in string used as a part of URL (e.g. '%' => '%25', '@' => '%40'...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • FormatURL - Format URL - truncate the middle part of the directory to fit to the requested lenght.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HidePassword - Hide password in an URL - replaces the password in the URL by 'PASSWORD' string. If there is no password in the URL the original URL is returned. It should be used when an URL is logged to y2log or when it is displayed to user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HidePasswordToken - Hide password token in parsed URL (by URL::Parse()) - the password is replaced by 'PASSWORD' string. Similar to HidePassword() but uses a parsed URL as the input.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MakeMapFromParams - Reads list of HTTP params and returns them as map. (Useful also for cd:/, dvd:/, nfs:/ ... params) Neither keys nor values are HTML-unescaped, see UnEscapeString().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MakeParamsFromMap - Returns string made of HTTP params. It's a reverse function to MakeMapFromParams(). Neither keys nor values are HTML-escaped, use EscapeString() if needed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parse - Tokenize URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • UnEscapeString - Escape reserved characters in string used as a part of URL (e.g. '%25' => '%', '%40' => '@'...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform_map_filename - Transform map used for (un)escaping characters in file location part of an URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform_map_passwd - Transform map used for (un)escaping characters in username/password part of an URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform_map_query - Transform map used for (un)escaping characters in query part of a URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.1. Build

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Build URL from tokens as parsed with Parse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - url, empty string if invalid data is used to build the url.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RFC 2396 (updated by RFC 2732)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • also perl-URI: URI(3)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.2. Check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Check URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if correct

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RFC 2396 (updated by RFC 2732)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • also perl-URI: URI(3)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.3. EscapeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Escape reserved characters in string used as a part of URL (e.g. '%' => '%25', '@' => '%40'...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map<string,string> transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - escaped string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 141. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	URL::EscapeString ("http://some.nice.url/:with:/$p#ci&l/ch@rs/", URL::transform_map_passwd)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		-> http%3a%2f%2fsome.nice.url%2f%3awith%3a%2f%24p#ci%26l%2fch%40rs%2f


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.4. FormatURL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Format URL - truncate the middle part of the directory to fit to the requested lenght.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer len

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - Truncated URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 142. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     FormatURL("http://download.opensuse.org/very/log/path/which/will/be/truncated/target_file", 45)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    &nbsp;&nbsp;&nbsp;&nbsp;-> "http://download.opensuse.org/.../target_file"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     FormatURL("http://download.opensuse.org/very/log/path/which/will/be/truncated/target_file", 60)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    &nbsp;&nbsp;&nbsp;&nbsp;-> "http://download.opensuse.org/very/.../be/truncated/target_file"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parse should be used to convert URL string to a map (tokens parameter)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.5. HidePassword

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide password in an URL - replaces the password in the URL by 'PASSWORD' string. If there is no password in the URL the original URL is returned. It should be used when an URL is logged to y2log or when it is displayed to user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - new URL with 'PASSWORD' password or unmodified URL if there is no password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.6. HidePasswordToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide password token in parsed URL (by URL::Parse()) - the password is replaced by 'PASSWORD' string. Similar to HidePassword() but uses a parsed URL as the input.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - map with replaced password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.7. MakeMapFromParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Reads list of HTTP params and returns them as map. (Useful also for cd:/, dvd:/, nfs:/ ... params) Neither keys nor values are HTML-unescaped, see UnEscapeString().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map <string, string> - params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 143. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MakeMapFromParams ("device=sda3&login=aaa&password=bbb") -> $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "device"   : "sda3",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "login"    : "aaa",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "password" : "bbb"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.8. MakeParamsFromMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string made of HTTP params. It's a reverse function to MakeMapFromParams(). Neither keys nor values are HTML-escaped, use EscapeString() if needed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map <string, string> params_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 144. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       MakeMapFromParams ($[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "param1" : "a",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "param2" : "b",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         "param3" : "c",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       ]) -> "param1=a&param2=b&param3=c"


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MakeMapFromParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.9. Parse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tokenize URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - URL split to tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 145. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Parse("http://name:pass@www.suse.cz:80/path/index.html?question#part") ->
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "scheme"  : "http",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "host"    : "www.suse.cz"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "port"    : "80",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "path"    : /path/index.html",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "user"    : "name",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "pass"    : "pass",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "query"   : "question",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             "fragment": "part"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.3.10. UnEscapeString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Escape reserved characters in string used as a part of URL (e.g. '%25' => '%', '%40' => '@'...)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map<string,string> transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - unescaped string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 146. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	URL::UnEscapeString ("http%3a%2f%2fsome.nice.url%2f%3awith%3a%2f%24p#ci%26l%2fch%40rs%2f", URL::transform_map_passwd)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		-> http://some.nice.url/:with:/$p#ci&l/ch@rs/


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.4.1. transform_map_filename

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Transform map used for (un)escaping characters in file location part of an URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.4.2. transform_map_passwd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Transform map used for (un)escaping characters in username/password part of an URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.4.3. transform_map_query

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Transform map used for (un)escaping characters in query part of a URL. It doesn't contain '%' because this character must be used in a particular order (the first or the last) during processing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Hostname
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    305.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      306. Update

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      306.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Arvin Schnell <arvin@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Purpose: Update module

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      306.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Detach -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • DropObsoletePackages - Drops packages defined in control file (string) software->dropped_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetBaseSelections - Get all available base selections sorted in reverse order (highest ordered bases selection comes first).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • GetProductName - Read product name and version for the old and new release. Fill Installation::installedVersion and Installation::updateVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • InitUpdate - Set initial values for variables that user can't change. They are defined in the control file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • IsProductSupportedForUpgrade - Returns whether the installed product is supported for upgrade. (Functionality for FATE #301844).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OnlyUpdateInstalled - Returns whether upgrade process should only update installed packages or also install new packages. True means - do not upgrade, only update packages. (Functionality for FATE #301844).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ProductsCompatible - Check if installed product and product to upgrade to are compatible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ProposeSelection - Propose a selection for the update and save it's name in Update::selected_selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Reset -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SilentlyDowngradePackages - Returns whether upgrade process should silently downgrade packages if needed. 'true' means that packages might be downgraded, 'nil' is returned when the feature is not supported in the control file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • fill_version_map -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.1. Detach

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.2. DropObsoletePackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Drops packages defined in control file (string) software->dropped_packages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • bnc #300540

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.3. GetBaseSelections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get all available base selections sorted in reverse order (highest ordered bases selection comes first).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.4. GetProductName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read product name and version for the old and new release. Fill Installation::installedVersion and Installation::updateVersion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.5. InitUpdate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set initial values for variables that user can't change. They are defined in the control file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.6. IsProductSupportedForUpgrade

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether the installed product is supported for upgrade. (Functionality for FATE #301844).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.7. OnlyUpdateInstalled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether upgrade process should only update installed packages or also install new packages. True means - do not upgrade, only update packages. (Functionality for FATE #301844).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.8. ProductsCompatible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Check if installed product and product to upgrade to are compatible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true if update is possible

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.9. ProposeSelection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Propose a selection for the update and save it's name in Update::selected_selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.10. Reset

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.11. SilentlyDowngradePackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns whether upgrade process should silently downgrade packages if needed. 'true' means that packages might be downgraded, 'nil' is returned when the feature is not supported in the control file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.3.12. fill_version_map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map <string, any>& data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • SuSERelease

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        306.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          307. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          307.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            307.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetBooleanValue - Retrieves the specified value and casts to a boolean.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetIntegerValue - Retrieves the specified value and casts to an integer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetStringValue - Retrieves the specified value and casts to a String.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetValue - Retrieves the specified value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetValue - Writes a key value pair for specified section.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3.1. GetBooleanValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Retrieves the specified value and casts to a boolean.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3.2. GetIntegerValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Retrieves the specified value and casts to an integer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • integer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3.3. GetStringValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Retrieves the specified value and casts to a String.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3.4. GetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Retrieves the specified value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any - The value of this key.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.3.5. SetValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Writes a key value pair for specified section.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string section

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • boolean - True if the settings were written to disk successfully. False on failure.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              307.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                308. UsersUI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                UI-related routines to be run from perl modules (Users.pm etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                308.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Jiri Suchomel <jsuchome@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                308.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3.1. GetPasswdErrorMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Error messages for errors detected during reading via .passwd agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • integer errno

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string more

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - error message

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3.2. HashPassword

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string method

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string pw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3.3. ReadNISConfigurationType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If we can ask and are a NIS server, ask which set of users to administer and set UserWriteStack accordingly.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string basedir

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3.4. RecodeUTF

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  recode the string from "environment encoding" to UTF-8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.3.5. SystemUserName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return the translated name for system user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  308.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    309. VM_XEN

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    309.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      309.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          309.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          309.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          309.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          309.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SuSEFirewall
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          309.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            310. ValueBrowser

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Useful tool for viewing any variable contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            310.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Martin Vidner <mvidner@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Dan Vesely?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            310.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BrowseTree - Shows tree with contents of variable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • BrowseTreeHelper - Creates tree with contents of variable. This function creates the tree items and returns them as term. This offers using the generated output in your behavior, such as data-structure browser with editor. Heavy recursion...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DebugBrowse - Write contents of variable to log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DebugBrowseHelper - Write contents of variable to log file. This function does the job. Heavy recursion...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.3.1. BrowseTree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Shows tree with contents of variable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example 147. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                map a = $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "first" : 35,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "second" : [ 1, 2, 3, 4, 5],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   "third" : $[ "a" : 15, `b: `VBox () ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ValueBrowser::BrowseTree (a);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.3.2. BrowseTreeHelper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Creates tree with contents of variable. This function creates the tree items and returns them as term. This offers using the generated output in your behavior, such as data-structure browser with editor. Heavy recursion...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string indent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • term

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.3.3. DebugBrowse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write contents of variable to log file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.3.4. DebugBrowseHelper

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Write contents of variable to log file. This function does the job. Heavy recursion...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • any variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • string indent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              310.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                311. Vendor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                provide vendor/driver update disk functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                311.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Klaus Kaempf <kkaempf@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                311.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • DriverUpdate1 - DriverUpdate copy /update/* to target:/tmp/update/ !! can only be called in inst_finish !!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.3.1. DriverUpdate1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DriverUpdate copy /update/* to target:/tmp/update/ !! can only be called in inst_finish !!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  311.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    312. Version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    yast2 package version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    312.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Michal Svec <msvec@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    312.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • yast2 - Version of the yast2 package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      312.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      312.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      312.4.1. yast2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Version of the yast2 package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      312.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      313. WOL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      313.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        313.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            313.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            313.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            313.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            313.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Popup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            313.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              314. WebpinPackageSearch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              YaST API to api.opensuse-community.org

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              314.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Katarina Machalkova <kmachalkova@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              314.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3.1. GetBaseSearchURL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns base search URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3.2. MatchesCurrentArchitecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns whether the current architecture matches the list of architectures got as a parameter. The current architecture is backward compatible, so also dependencies are taken into account.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <string> archs_to_check

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - whether they match the current architecture

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example 148. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	// current architecture is "i386"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	MatchesCurrentArchitecture (["noarch", "ppc", "i386"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	MatchesCurrentArchitecture (["noarch"]) -> true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	MatchesCurrentArchitecture (["x86_64"]) -> false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	MatchesCurrentArchitecture (["ppc"]) -> false


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3.3. PrepareOneClickInstallDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Writes XML configuration file for OnleClickInstall client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <map> packages_to_install

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string save_to_file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SearchForPackages() for the format of <map> package_to_install

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3.4. SearchForPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Searches for packages using Webpin XML API.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string search_for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string distribution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • map <string, boolean> search_in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • list <map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example 149. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   SearchForPackages (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	"desktop",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	nil,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	$[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	    "name" : true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	    "description" : true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                	    "contents" : false,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   	]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ->
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     $[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "archs":[
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "ppc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "checksum":"e0cbdbf03ce47dfd5c5f885b86706ddfa023d8dc",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "distro":"openSUSE_110",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "name":"xfce4-desktop",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "priority":"5",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "repoURL":"http://download.opensuse.org/distribution/11.0/repo/oss/suse",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "summary":"Desktop manager for the Xfce Desktop Environment",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "version":"4.4.2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   ]


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.3.5. SetBaseSearchURL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Sets base search URL WARNING: Use this only if you know what you are doing!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string new_base_url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • SuSERelease
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • URL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                314.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  315. Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  315.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stefan Hundhammer <sh@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Provides the wizard dialog (common screen for all YaST2 installation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • modules) and functions to set the contents, to replace and restore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • special widgets.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  315.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.1. AbortAcceptButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Abort", "Accept"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.2. AbortApplyFinishButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Abort", "Apply", "Finish"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.3. AbortInstallationAcceptButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Abort Installation", "Accept"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.4. AcceptDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a standard wizard dialog with buttons "Cancel", "Accept"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - describing the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.5. AddMenu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> - Updated Menu Data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.6. AddMenuEntry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add Menu Entry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string parent_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> - Updated Menu Data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.7. AddSubMenu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add Sub Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string parent_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> - Updated Menu Data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.8. AddTreeItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Add Tree Item to tree enabled Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string parent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> - Updated Tree Data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.9. BackAbortInstallationNextButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Back", "Abort Installation", "Next"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.10. BackAbortNextButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Back", "Abort", "Next"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.11. BackNextButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Back", "Next"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.12. CancelAcceptButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Cancel", "Accept"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.13. CancelOKButtonBox

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a button box with buttons "Cancel", "OK"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - a widget tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.14. ClearContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Clear the wizard contents.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.15. ClearTitleIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Clear the wizard 'title' icon, i.e. replace it with nothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SetTitleIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.16. CloseDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Close a wizard dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.17. CreateDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create and open a typical installation wizard dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.18. CreateMenu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create the menu in the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Menu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.19. CreateTree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create the tree in the dialog, replaces helpspace with new tree widget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map> Tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.20. CreateTreeDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create and open a Tree wizard dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.21. DeleteMenus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete Menu items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.22. DeleteTreeItems

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete Tree items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.23. DisableAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disable the wizard's "Abort" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EnableAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.24. DisableBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disable the wizard's "Back" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EnableBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.25. DisableCancelButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disable the wizard's "Cancel" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EnableCancelButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.26. DisableNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disable the wizard's "Next" (or "Accept") button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • EnableNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.27. EnableAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable the wizard's "Abort" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • DisableAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.28. EnableBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable the wizard's "Back" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • DisableBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.29. EnableCancelButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable the wizard's "Cancel" button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • DisableCancelButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.30. EnableNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable the wizard's "Next" (or "Accept") button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • DisableNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.31. GenericDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a Generic Dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term button_box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - term describing the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.32. GenericTreeDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a Generic Tree Dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term button_box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - term describing the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.33. HideAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RestoreAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.34. HideBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RestoreBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.35. HideNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RestoreNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.36. HideReleaseNotesButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hide the "Release Notes" button, if there is any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.37. IsWizardDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Check if the topmost dialog is a wizard dialog (i.e. has a widget with `id(`WizardDialog) )

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - True if topmost dialog is a wizard dialog, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.38. NextBackDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a standard wizard dialog with buttons "Next", "Back", "Abort".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - describing the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.39. OKDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns a standard wizard dialog with buttons "Cancel", "OK"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term - describing the dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.40. OpenAbortApplyFinishDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.41. OpenAcceptAbortStepsDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "Accept", "Cancel" that will also accept workflow steps.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.42. OpenAcceptDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.43. OpenAcceptStepsDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "Accept", "Cancel" that will also accept workflow steps.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.44. OpenCustomDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a wizard dialog with simple layout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term help_space_contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term button_box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • CloseDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.45. OpenDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open any wizard dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.46. OpenNextBackDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.47. OpenNextBackStepsDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.48. OpenOKDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a dialog with "OK", "Cancel" and set the keyboard focus to "OK".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.49. OpenTreeNextBackDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.50. QueryTreeItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Query Tree Item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - Tree Item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.51. ReplaceCustomHelp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.52. ReplaceHelp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Replace the wizard help subwindow with a custom widget.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.53. RestoreAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restore the wizard 'abort' button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HideAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.54. RestoreBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restore the wizard 'back' button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HideBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.55. RestoreHelp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restore the wizard help subwindow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.56. RestoreNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restore the wizard 'next' button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HideNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.57. RestoreScreenShotName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Restore the screenshot name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.58. RetranslateButtons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Retranslate the wizard buttons.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.59. SelectTreeItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Select Tree item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string tree_item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.60. SetAbortButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the dialog's "Abort" button with a new label and a new ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • any id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.61. SetBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the dialog's "Back" button with a new label and a new ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • any id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.62. SetContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the contents of a wizard dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean has_back

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean has_next

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.63. SetContentsButtons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set contents and Buttons of wizard dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string back_label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string next_label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.64. SetContentsFocus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the contents of a wizard dialog and define if to move focus to next button

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • term contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean has_back

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean has_next

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean set_focus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.65. SetDesktopIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the icon specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix. Warning: There are no desktop files in inst-sys. Use "SetTitleIcon" instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 150. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Opens /usr/share/applications/YaST2/lan.desktop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Reads "Icon" entry from there
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Sets the icon.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	SetDesktopIcon ("lan")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.66. SetDesktopTitle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the window title according to the name specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 151. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Opens /usr/share/applications/YaST2/lan.desktop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Reads (localized) "name" entry from there
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	// Sets the window title.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	SetDesktopTitle ("lan")


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.67. SetDialogTitle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the dialog title shown in the window manager's title bar.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string titleText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 152. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	SetDialogTitle ("DNS Server Configuration");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.68. SetFocusToBackButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the keyboard focus to the wizard's "Back" (or "Cancel") button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.69. SetFocusToNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the keyboard focus to the wizard's "Next" (or "Accept") button.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.70. SetHelpText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a new help text.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 153. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Wizard::SetHelpText("This is a help Text");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.71. SetNextButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the dialog's "Next" button with a new label and a new ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • any id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.72. SetProductName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set the product name for UI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.73. SetScreenShotName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a name for the current dialog:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • RestoreScreenShotName

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.74. SetTitleIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Sets the wizard 'title' icon to the specified icon from the standard icon directory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string icon_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 154. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    	SetTitleIcon ("yast-dns-server");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ClearTitleIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.75. ShowHelp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Open a popup dialog that displays a help text (rich text format).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string help_text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.76. ShowReleaseNotesButton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show a "Release Notes" button with the specified label and ID if there is a "steps" panel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.77. TimeoutUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Substitute for UI::TimeoutUserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_millisec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.78. UserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Substitute for UI::UserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • any - (maybe normalized) widget ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.3.79. WaitForEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Substitute for UI::WaitForEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer timeout_millisec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • SuSERelease

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    315.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      316. WizardHW

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Routines for generic hardware summary dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      316.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      316.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CreateHWDialog - Create the Hardware Wizard dialog Draw the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CreateRichTextDescription - Create rich text description of a device. It can be used for WizardHW::SetContents function for formatting richtext device descriptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • CreateWidget - Create CWM widtet for the hardware settings NOTE: The Init and Handle callbacks must be defined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • RunHWDialog - Draw the dialog, handle all its events via callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SelectedItem - Return the id of the currently selected item in the table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetContents - Set the information about hardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetRichDescription - Set the rich text description.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SetSelectedItem - Set which item is to be selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UnconfiguredDevice - Get propertly list of an unconfigured device. Should be used together with device name in CreateRichTextDescription() function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • UserInput - Wait for event from the event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • WaitForEvent - Wait for event from the event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.1. CreateHWDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create the Hardware Wizard dialog Draw the dialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string help

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<list> actions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.2. CreateRichTextDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create rich text description of a device. It can be used for WizardHW::SetContents function for formatting richtext device descriptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string title

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - rich text string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.3. CreateWidget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create CWM widtet for the hardware settings NOTE: The Init and Handle callbacks must be defined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<list> actions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any> - a map a widget for CWM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.4. RunHWDialog

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Draw the dialog, handle all its events via callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol - for wizard sequencer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.5. SelectedItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return the id of the currently selected item in the table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - id of the selected item

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.6. SetContents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the information about hardware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<map<string,any> > items

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.7. SetRichDescription

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set the rich text description.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string descr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.8. SetSelectedItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set which item is to be selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string selected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.9. UnconfiguredDevice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get propertly list of an unconfigured device. Should be used together with device name in CreateRichTextDescription() function.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • list<string> - a list of strings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.10. UserInput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Wait for event from the event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any> - a map with keys: "event" : any = event as returned from UI::UserInoput () "selected" : string = ID of the selected item in the list box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.3.11. WaitForEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Wait for event from the event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string,any> - a map with keys: "event" : map = event as returned from UI::WaitForEvent (), "selected" : string = ID of the selected item in the list box

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • CWM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        316.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          317. Wizard_hw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Wizard dialogs for hardware configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          317.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Jan Holesovsky <kendy@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • @deprecated This module is deprecated and will be removed soon. Use WizardHW instead.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          317.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • ConfiguredContent - Create the contents of screen with configured items.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DetectedContent - Create the content of the screen with the detected devices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SizeAtLeast - Encloses the content into VBoxes and HBoxes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • SpacingAround - Encloses the content into VBoxes and HBoxes with the appropriate spacings around it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.3.1. ConfiguredContent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create the contents of screen with configured items.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term table_header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list table_contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term above_table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term below_table

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term below_buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term - Content for the SetWizardContent[Buttons]() <B>UI elements ids:</B><table> <tr><td>Table</td><td>`table</td></tr> <tr><td>Button add</td><td>`add_button</td></tr> <tr><td>Button edit</td><td>`edit_button</td></tr> <tr><td>Button delete</td><td>`delete_button</td></tr> </table>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.3.2. DetectedContent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create the content of the screen with the detected devices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string frame_label

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list detected

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean has_restart

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string already_conf

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term - Content for the SetWizardContent[Buttons]()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.3.3. SizeAtLeast

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Encloses the content into VBoxes and HBoxes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term content

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float xsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float ysize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term - Contents sized at least <B>xsize</B>&nbsp;x&nbsp;<B>ysize</B>.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.3.4. SpacingAround

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Encloses the content into VBoxes and HBoxes with the appropriate spacings around it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term content

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float left

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float right

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float top

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • float bottom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • term - Content with spacings around it.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            317.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318. WorkflowManager

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Provides API for configuring workflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Lukas Ocilka <locilka@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Provides API for managing and configuring installation and

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • configuration workflow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Module was created as a solution for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FATE #129: Framework for pattern based Installation/Deployment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Module unifies Add-Ons and Patterns modifying the workflow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • AddWorkflow - Stores new workflow (if such workflow exists) into the Worflow Store.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • CleanWorkflowsDirectory - Removes all xml and ycp files from directory where

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • DumpCurrentSettings - Returns the current settings used by WorkflowManager. This function is just for debugging purpose.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetAdditionalFinishSteps - Returns list of additional inst_finish steps requested by additional workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetAllUsedControlFiles - Returns list of control-file names currently used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • HaveAdditionalWorkflows - Returns whether some additional control files are currently in use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • MergeWorkflows - Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PrepareProposals - Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PrepareSystemProposals - Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals. Works with base product proposals.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PrepareSystemWorkflows - Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows. Works with base product workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • PrepareWorkflows - Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RedrawWizardSteps - Redraws workflow steps. Function must be called when steps (or help for steps) are active. It doesn't work in case of active another dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • RemoveWorkflow - Removes workflow (if such workflow exists) from the Worflow Store. Alose removes the cached file but in the installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ResetWorkflow - Resets the Workflow (and proposals) to use the base workflow. It must be stored. Clears also all additional workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetAllUsedControlFiles - Sets list of control-file names to be used. ATTENTION: this is dangerous and should be used in rare cases only!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SetBaseWorkflow - Stores the current ProductControl settings as the initial settings. These settings are: workflows, proposals, inst_finish, and clone_modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • SomeWorkflowsWereChanged - Returns whether some additional control files were added or removed from the last time MergeWorkflows() was called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.1. AddWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stores new workflow (if such workflow exists) into the Worflow Store.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer src_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - whether successful (true also in case of no workflow file)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 155. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	AddWorkflow (`addon, 4, "");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.2. CleanWorkflowsDirectory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Removes all xml and ycp files from directory where

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.3. DumpCurrentSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the current settings used by WorkflowManager. This function is just for debugging purpose.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map <string, any> - of current settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		"workflows" : ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		"proposals" : ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		"inst_finish" : ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		"clone_modules" : ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		"unmerged_changes" : ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	];

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.4. GetAdditionalFinishSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of additional inst_finish steps requested by additional workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string which_steps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - steps to be called ...see which_steps parameter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.5. GetAllUsedControlFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns list of control-file names currently used

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> - files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.6. HaveAdditionalWorkflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether some additional control files are currently in use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - some additional control files are in use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.7. MergeWorkflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.8. PrepareProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <map> proposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <map> - updated proposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Input: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial,firstboot"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	Output: [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		$["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"firstboot"]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.9. PrepareSystemProposals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals. Works with base product proposals.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.10. PrepareSystemWorkflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows. Works with base product workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.11. PrepareWorkflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <map> workflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <map> - updated workflows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.12. RedrawWizardSteps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Redraws workflow steps. Function must be called when steps (or help for steps) are active. It doesn't work in case of active another dialog.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.13. RemoveWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Removes workflow (if such workflow exists) from the Worflow Store. Alose removes the cached file but in the installation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • symbol type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • integer src_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • string name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - whether successful (true also in case of no workflow file)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 156. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	RemoveWorkflow (`addon, 4, "");


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.14. ResetWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resets the Workflow (and proposals) to use the base workflow. It must be stored. Clears also all additional workflows.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.15. SetAllUsedControlFiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sets list of control-file names to be used. ATTENTION: this is dangerous and should be used in rare cases only!

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • list <string> new_list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 157. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            	SetAllUsedControlFiles (["/tmp/new_addon_control.xml", "/root/special_addon.xml"]);


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • GetAllUsedControlFiles()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.16. SetBaseWorkflow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stores the current ProductControl settings as the initial settings. These settings are: workflows, proposals, inst_finish, and clone_modules.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.3.17. SomeWorkflowsWereChanged

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns whether some additional control files were added or removed from the last time MergeWorkflows() was called.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • boolean - boolen see description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.4.1. additional_finish_steps_before_chroot

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Additional inst_finish settings defined by additional control files. They are always empty at the begining.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Label
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProductControl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ProductFeatures
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • String
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Wizard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            318.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              319. X11Version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              319.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                319.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    319.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    319.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    319.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    319.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Package

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    319.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      320. XML

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      XML routines

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      320.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      320.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • XMLError - The error string from the xml parser. It should be used when the agent did not return content. A reset happens before a new XML parsing starts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • XMLToYCPFile - Read XML file into YCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • XMLToYCPString - Read XML string into YCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • YCPToXMLFile - YCPToXMLFile() Write YCP data into formated XML file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • xmlCreateDoc - define a new doc type with custom settings, if not defined, global settings will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3.1. XMLError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The error string from the xml parser. It should be used when the agent did not return content. A reset happens before a new XML parsing starts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string - parser error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3.2. XMLToYCPFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read XML file into YCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string xmlFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> - Map with YCP data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3.3. XMLToYCPString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Read XML string into YCP

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string xmlString

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map<string, any> - Map with YCP data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3.4. YCPToXMLFile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        YCPToXMLFile() Write YCP data into formated XML file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol docType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map contents

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • string outputPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • boolean - true on sucess

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.3.5. xmlCreateDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        define a new doc type with custom settings, if not defined, global settings will be used.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • symbol doc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • map docSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        320.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        321. XMessages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        321.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          321.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              321.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              321.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              321.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              322. XVersion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Differences between multiple X versions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              322.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              322.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Path - Provide a path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • binPath - Provide path to bin directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • fontPath - Provide path to font directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • includePath - Provide path to include directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • infoPath - Provide path to info directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • lib64Path - Provide path to lib64 directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • libPath - Provide path to lib directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • manPath - Provide path to man directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • sharePath - Provide path to share directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.1. Path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide a path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - required path, nil if not defined

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.2. binPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to bin directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/bin, resp. /usr/bin

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.3. fontPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to font directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/font, resp. /usr/font

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.4. includePath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to include directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/include, resp. /usr/include

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.5. infoPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to info directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/info, resp. /usr/info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.6. lib64Path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to lib64 directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/lib64, resp. /usr/lib64

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.7. libPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to lib directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/lib, resp. /usr/lib

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.8. manPath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to man directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/man, resp. /usr/man

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.3.9. sharePath

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Provide path to share directory of X11

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • string - path to /usr/X11R6/share, resp. /usr/share

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                322.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                none

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323. Xpram

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Xpram settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Ihno Krumreich <Ihno@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Read - Read all xpram settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • ReadSysconfig - Read xpram settings from /etc/sysconfig/xpram

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Write - Write all xpram settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • force - Should xpram be really started?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fstype - Filesystem used for the XpRAM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • mountpoint - mountpoint used for xpram

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • start - Should xpram be started?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.3.1. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read all xpram settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.3.2. ReadSysconfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Read xpram settings from /etc/sysconfig/xpram

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true when file exists

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.3.3. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Write all xpram settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4.1. force

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Should xpram be really started?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4.2. fstype

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Filesystem used for the XpRAM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4.3. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4.4. mountpoint

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                mountpoint used for xpram

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.4.5. start

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Should xpram be started?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • FileUtils
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                323.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324. Y2ModuleConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Read data from desktop files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Anas Nashif <nashif@suse.de>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3.1. Deps

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Simple dependency resolving

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • list<map>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3.2. SetDesktopIcon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set Desktop Icon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3.3. Y2ModuleConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Y2ModuleConfig () Constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3.4. getResource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get resource name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string default_resource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string - resource as defined in desktop file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.3.5. getResourceData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get resource data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • map resourceMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • string resource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • any - Resource Data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.4.1. MenuTreeData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MenuTreeData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Desktop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Directory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Installation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Profile
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Wizard

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  324.5.2. Module Includes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325. ZFCPController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Controller settings, input and output functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.1. Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Jiri Srain <jsrain@suse.cz>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.2. Summary of Module Globals

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Abort - Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ActivateDisk - Activate a disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • AutoPackages - Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Available - Is this kind of disk controller available?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • DeactivateDisk - Activate a disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Export - Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • GetControllers - Get available zfcp controllers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • HexNumSize - Update the size of hexa number via adding leading zeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Import - Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IsAvailable - Check if ZFCP subsystem is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Modified - Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ProbeDisks - Get available disks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Read - Read all controller settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary - Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Write - Write all controller settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List of Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • modified - Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • proposal_valid -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • write_only - Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3. Global Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.1. Abort

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Abort function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - blah blah lahjk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.2. ActivateDisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Activate a disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string wwpn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string lun

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.3. AutoPackages

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - with 2 lists.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.4. Available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Is this kind of disk controller available?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if it is

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.5. DeactivateDisk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Activate a disk

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string wwpn

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string lun

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.6. Export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Dump the controller settings to a single map (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map - Dumped settings (later acceptable by Import ())

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.7. GetControllers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get available zfcp controllers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<map<string,any> > - of availabel Controllers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.8. HexNumSize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update the size of hexa number via adding leading zeros

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string hex

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • integer digits

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • string - hex string with specified length

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.9. Import

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get all controller settings from the first parameter (For use by autoinstallation.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • map settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - True on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.10. IsAvailable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Check if ZFCP subsystem is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - whether the ZFCP-System is availble at all

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.11. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Prototypes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.12. Modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true if modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.13. ProbeDisks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get available disks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.14. Read

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Read all controller settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.15. Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a textual summary and a list of unconfigured cards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • list<string> - summary of the current configuration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.3.16. Write

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write all controller settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Return value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • boolean - true on success

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.4. Global Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.4.1. modified

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Data was modified?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.4.2. proposal_valid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.4.3. write_only

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Write only, used during autoinstallation. Don't run services and SuSEconfig, it's all done at one place.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.5. Module Requirements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.5.1. Module Imports

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Arch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Popup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Report
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Stage
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    325.5.2. Module Includes